Skip to content

Get the credentials saved for every integration

GET
/{resource}/integrations
curl --request GET \
--url https://example.com/v1/example/integrations \
--header 'Authorization: Bearer <token>'
resource
required
string
/^\d+$/

The project ID of the space

What’s saved, for each integration

Media typeapplication/json
object
multiset
required
object
project
required

Credentials saved for the space or its workspace, as far as they can be described without giving them away.

object
configured
required

Whether credentials are saved.

boolean
endpoint

The API they’re used with.

string
idHint

The first four characters of the client or token id, to tell which is saved.

string
updatedAt

When they were saved, in milliseconds since the Unix epoch. Not known for credentials saved before it was recorded.

integer
workspace
required

Credentials saved for the space or its workspace, as far as they can be described without giving them away.

object
configured
required

Whether credentials are saved.

boolean
endpoint

The API they’re used with.

string
idHint

The first four characters of the client or token id, to tell which is saved.

string
updatedAt

When they were saved, in milliseconds since the Unix epoch. Not known for credentials saved before it was recorded.

integer
active
required

Which credentials are used: the space’s own ahead of the workspace’s, or none.

string | null
Allowed values: project workspace
matterport
required
object
project
required

Credentials saved for the space or its workspace, as far as they can be described without giving them away.

object
configured
required

Whether credentials are saved.

boolean
endpoint

The API they’re used with.

string
idHint

The first four characters of the client or token id, to tell which is saved.

string
updatedAt

When they were saved, in milliseconds since the Unix epoch. Not known for credentials saved before it was recorded.

integer
workspace
required

Credentials saved for the space or its workspace, as far as they can be described without giving them away.

object
configured
required

Whether credentials are saved.

boolean
endpoint

The API they’re used with.

string
idHint

The first four characters of the client or token id, to tell which is saved.

string
updatedAt

When they were saved, in milliseconds since the Unix epoch. Not known for credentials saved before it was recorded.

integer
active
required

Which credentials are used: the space’s own ahead of the workspace’s, or none.

string | null
Allowed values: project workspace

Example

{
"multiset": {
"project": {
"idHint": "a1b2…"
},
"workspace": {
"idHint": "a1b2…"
},
"active": "project"
},
"matterport": {
"project": {
"idHint": "a1b2…"
},
"workspace": {
"idHint": "a1b2…"
},
"active": "project"
}
}

The token is missing or invalid.

Media typeapplication/json
object
error
required

A description of the error

string
code
required

A stable identifier for the kind of error

string
issues

For invalidBody: what failed validation, and where

Array<object>
object

Example generated

{
"error": "example",
"code": "example",
"issues": [
{}
]
}

The token has no access to this space.

Media typeapplication/json
object
error
required

A description of the error

string
code
required

A stable identifier for the kind of error

string
issues

For invalidBody: what failed validation, and where

Array<object>
object

Example generated

{
"error": "example",
"code": "example",
"issues": [
{}
]
}

Too many requests. Retry after Retry-After seconds.

Media typeapplication/json
object
error
required

A description of the error

string
code
required

A stable identifier for the kind of error

string
issues

For invalidBody: what failed validation, and where

Array<object>
object

Example generated

{
"error": "example",
"code": "example",
"issues": [
{}
]
}
Retry-After
integer

Seconds to wait before retrying

Something upstream failed.

Media typeapplication/json
object
error
required

A description of the error

string
code
required

A stable identifier for the kind of error

string
issues

For invalidBody: what failed validation, and where

Array<object>
object

Example generated

{
"error": "example",
"code": "example",
"issues": [
{}
]
}

The space is moving between servers. Retry after Retry-After seconds.

Media typeapplication/json
object
error
required

A description of the error

string
code
required

A stable identifier for the kind of error

string
issues

For invalidBody: what failed validation, and where

Array<object>
object

Example generated

{
"error": "example",
"code": "example",
"issues": [
{}
]
}
Retry-After
integer

Seconds to wait before retrying

Something upstream timed out.

Media typeapplication/json
object
error
required

A description of the error

string
code
required

A stable identifier for the kind of error

string
issues

For invalidBody: what failed validation, and where

Array<object>
object

Example generated

{
"error": "example",
"code": "example",
"issues": [
{}
]
}