Sign in with Tickwire (OAuth) and connected apps

AI agents. Generated from the OpenAPI document the services export (/openapi.json).

Samples use the placeholders YOUR_API_KEY and YOUR_ACCOUNT_ID. Paste a sandbox key (twsk_…) to fill them in and to use Try it. It stays in this browser tab and is only sent to the sandbox, never to the live API.

Sandbox key

Sandbox account id

Try it is off in this build: No sandbox URL is configured for this build of the docs.

GET `/.well-known/oauth-authorization-server`

As Metadata Auth: X-API-Key

RFC 8414 Authorization Server Metadata.

Responses

200 Successful Response

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X GET 'https://api.tickwire.io/.well-known/oauth-authorization-server' \
  -H 'X-API-Key: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "GET",
        "/.well-known/oauth-authorization-server",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("GET", "/.well-known/oauth-authorization-server");
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

GET `/oauth/authorize`

Authorize Auth: X-API-Key

Validate the request, then send the browser to the consent page.

Responses

200 Successful Response

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X GET 'https://api.tickwire.io/oauth/authorize' \
  -H 'X-API-Key: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "GET",
        "/oauth/authorize",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("GET", "/oauth/authorize");
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

POST `/oauth/consent/decide`

Consent Decide Auth: X-API-Key

Approve or deny; answers where to send the browser next.

Parameters of POST /oauth/consent/decide
Parameter	In	Type	Description
`X-Reason`	header	`string \| null`
`X-Tickwire-CSRF`	header	`string \| null`

Request body object required

Responses

200 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X POST 'https://api.tickwire.io/oauth/consent/decide' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'X-Reason: why you are doing this' \
  -H 'Content-Type: application/json' \
  -d '{}'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "POST",
        "/oauth/consent/decide",
        json={},
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("POST", "/oauth/consent/decide", {
  body: {},
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

POST `/oauth/consent/view`

Consent View Auth: X-API-Key

What the consent page shows, plus a consent token bound to this session.

Parameters of POST /oauth/consent/view
Parameter	In	Type	Description
`X-Tickwire-CSRF`	header	`string \| null`

Request body object required

Responses

200 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X POST 'https://api.tickwire.io/oauth/consent/view' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "POST",
        "/oauth/consent/view",
        json={},
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("POST", "/oauth/consent/view", {
  body: {},
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

POST `/oauth/register`

Register Auth: X-API-Key

RFC 7591 Dynamic Client Registration.

Responses

201 Successful Response

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X POST 'https://api.tickwire.io/oauth/register' \
  -H 'X-API-Key: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "POST",
        "/oauth/register",
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("POST", "/oauth/register", {
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

POST `/oauth/revoke`

Revoke Auth: X-API-Key

RFC 7009 token revocation.

Responses

200 Successful Response

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X POST 'https://api.tickwire.io/oauth/revoke' \
  -H 'X-API-Key: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "POST",
        "/oauth/revoke",
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("POST", "/oauth/revoke", {
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

POST `/oauth/token`

Token Auth: X-API-Key

Exchange an authorization code or a refresh token for tokens. Never retry a refresh token that was refused: start a new sign-in instead.

Responses

200 Successful Response

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X POST 'https://api.tickwire.io/oauth/token' \
  -H 'X-API-Key: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "POST",
        "/oauth/token",
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("POST", "/oauth/token", {
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

GET `/v1/connected-apps`

List Apps Auth: X-API-Key

Apps connected to this tenant through Sign in with Tickwire, oldest first. Cursor-paginated: {apps, has_more, next_cursor}.

Parameters of GET /v1/connected-apps
Parameter	In	Type	Description
`include_ended`	query	`boolean`
`limit`	query	`integer`	Page size, 1..500 (default 100).
`cursor`	query	`string \| null`	The next_cursor of the previous page, unchanged.

Responses

200 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X GET 'https://api.tickwire.io/v1/connected-apps' \
  -H 'X-API-Key: YOUR_API_KEY'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "GET",
        "/v1/connected-apps",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("GET", "/v1/connected-apps");
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

DELETE `/v1/connected-apps/{grant_id}`

Disconnect App Auth: X-API-Key

Disconnect: revoke the app's agent key and all of its tokens.

Parameters of DELETE /v1/connected-apps/{grant_id}
Parameter	In	Type
`grant_id` required	path	`string`
`X-Actor`	header	`string \| null`
`X-Reason`	header	`string \| null`

Responses

200 Successful Response
422 Validation Error · HTTPValidationError

Errors (common for this kind of call; every error uses one envelope)

curl

curl -sS -X DELETE 'https://api.tickwire.io/v1/connected-apps/GRANT_ID' \
  -H 'X-API-Key: YOUR_API_KEY' \
  -H 'X-Reason: why you are doing this'

Python

from tickwire import Tickwire

with Tickwire("https://api.tickwire.io", "YOUR_API_KEY") as tw:
    result = tw.request(
        "DELETE",
        "/v1/connected-apps/GRANT_ID",
        idempotency_key="my-request-1",
        reason="why you are doing this",
    )
    print(result)

TypeScript

import { TickwireClient } from "@tickwire/sdk";

const tw = new TickwireClient({ baseUrl: "https://api.tickwire.io", token: "YOUR_API_KEY" });
const result = await tw.request("DELETE", "/v1/connected-apps/GRANT_ID", {
  idempotencyKey: "my-request-1",
  reason: "why you are doing this",
});
console.log(result);
tw.close();

Try it in the sandbox

Try it is off in this build of the docs: no sandbox URL is configured. The samples above work against the sandbox with your sandbox key.

Sign in with Tickwire (OAuth) and connected apps

GET /.well-known/oauth-authorization-server

GET /oauth/authorize

POST /oauth/consent/decide

POST /oauth/consent/view

POST /oauth/register

POST /oauth/revoke

POST /oauth/token

GET /v1/connected-apps

DELETE /v1/connected-apps/{grant_id}

GET `/.well-known/oauth-authorization-server`

GET `/oauth/authorize`

POST `/oauth/consent/decide`

POST `/oauth/consent/view`

POST `/oauth/register`

POST `/oauth/revoke`

POST `/oauth/token`

GET `/v1/connected-apps`

DELETE `/v1/connected-apps/{grant_id}`