Skip to content

Get the caller

GET
/me
curl --request GET \
--url https://api.sendwing.app/api/me \
--header 'x-api-key: <x-api-key>'

Who the API key or access token is: the key and its workspace, or the connected app, the member who connected it and their workspace. Use it to check a credential, and to find the organizationId other routes need.

The caller

Media typeapplication/json
One of:
object
type
required
string
Allowed value: apiKey
apiKey
required
object
id
required
string
name
required
string | null
organizationId
required

The workspace the key belongs to

string
permissions
Any of:

What the caller can do, by resource, like { "contact": ["read", "update"] }

object
key
additional properties
Array<string>

Example

{
"type": "apiKey"
}

The API key or access token is missing, invalid or expired

Media typeapplication/json
object
error
required

What went wrong, in words you can show people

string
issues

For a 400: each invalid field, by its path in the request, like events.0.name

Array<object>
object
path
required
string
message
required
string
requestId

For a 5xx: quote it when contacting support

string

Example generated

{
"error": "example",
"issues": [
{
"path": "example",
"message": "example"
}
],
"requestId": "example"
}

Too many requests; wait for the seconds in Retry-After

Media typeapplication/json
object
error
required

What went wrong, in words you can show people

string
issues

For a 400: each invalid field, by its path in the request, like events.0.name

Array<object>
object
path
required
string
message
required
string
requestId

For a 5xx: quote it when contacting support

string

Example generated

{
"error": "example",
"issues": [
{
"path": "example",
"message": "example"
}
],
"requestId": "example"
}