Create an API key

POST

/api/v1/settings/api-keys

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/settings/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "label": "example", "scopes": [ "example" ] }'

Returns the plain token once, in plain_token; it is stored hashed and cannot be retrieved again.

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

label

required

string

>= 1 characters <= 100 characters

scopes

Array<string>

Example^generated

{
  "label": "example",
  "scopes": [
    "example"
  ]
}

Responses

201

The new key and its plain token

Media typeapplication/json

object

key

required

object

id

required

string

label

required

string

token_prefix

required

string

scopes

required

Array<string>

last_used_at

required

string | null

revoked_at

required

string | null

created_at

required

string

updated_at

required

string

plain_token

required

string

Example^generated

{
  "key": {
    "id": "example",
    "label": "example",
    "token_prefix": "example",
    "scopes": [
      "example"
    ],
    "last_used_at": "example",
    "revoked_at": "example",
    "created_at": "example",
    "updated_at": "example"
  },
  "plain_token": "example"
}

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}