Skip to content
Swft Docs

List partner API keys in a workspace.

GET
/workspaces/{workspaceId}/partner-keys
 
curl --request GET \
  --url https://api.swft.co.uk/workspaces/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/partner-keys

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspaceId
required
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200 ”

A list of keys (plaintext NOT included).

Media type application/json
object
keys
required
Array<object>
object
id
required
string format: uuid
workspace_id
required
string format: uuid
key_prefix
required

Visible prefix of the key (full plaintext only returned on creation).

string
name
required
string
scopes
required
Array<string>
pinned_version
required
string
livemode
required
boolean
last_used_at
required
string | null
revoked_at
required
string | null
created_at
required
string
Example generated
{
  "keys": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "key_prefix": "example",
      "name": "example",
      "scopes": [
        "example"
      ],
      "pinned_version": "example",
      "livemode": true,
      "last_used_at": "example",
      "revoked_at": "example",
      "created_at": "example"
    }
  ]
}

400

Section titled “400 ”

Bad request — malformed input or missing/invalid parameters.

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}

401

Section titled “401 ”

Missing or invalid authentication.

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}

403

Section titled “403 ”

Authenticated but not authorised (e.g. wrong workspace).

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}

404

Section titled “404 ”

Resource not found.

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}

409

Section titled “409 ”

Conflict — idempotency-key reuse, duplicate resource, etc.

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}

429

Section titled “429 ”

Rate-limited.

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}

500

Section titled “500 ”

Internal server error.

Media type application/json
object
error
required
object
type
required
string format: uri
code
required
string
message
required
string
doc_url
required
string format: uri
request_id
required
string
param
string
meta
object
key
additional properties
Example generated
{
  "error": {
    "type": "https://example.com",
    "code": "example",
    "message": "example",
    "doc_url": "https://example.com",
    "request_id": "example",
    "param": "example",
    "meta": {
      "additionalProperty": "example"
    }
  }
}