Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Get a specific API token by ID.
Get all API tokens.
Update API token.
Create a new token for the specific account.
Delete API token.
Disable the API token.
Enable API token.
/v1/accounts/api-tokens/{id}/disable
curl -L \
--request POST \
--url '/v1/accounts/api-tokens/{id}/disable'{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"status": "text",
"name": "text",
"description": "text",
"icon": "text",
"lastAccessAt": "2025-02-22T08:44:15.727Z",
"token": "text",
"account": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"account": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
"[Circular Reference]"
]
},
"logo": "text",
"isDefault": true,
"modules": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"description": "text",
"isConfigurable": true,
"isEnabledByDefault": true,
"paid": true,
"name": "text",
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"sharedAccount": true,
"configurable": true,
"default": true,
"paid": true,
"type": [
"text"
]
},
"accountTypes": [
"text"
]
}
],
"users": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"icon": "text",
"lastLoginAt": "2025-02-22T08:44:15.727Z",
"settings": {
"cultureCode": "text",
"languageCode": "text"
},
"name": "text",
"currentAccount": "[Circular Reference]",
"accounts": "[Circular Reference]"
}
],
"buyers": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"contact": "[Circular Reference]",
"externalIds": {
"erpCompanyContact": "text",
"erpCustomer": "text",
"accountExternalId": "text"
},
"status": "Active",
"icon": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"taxId": "text",
"account": "[Circular Reference]",
"name": "text",
"errors": [
{
"id": "text",
"message": "text",
"parameters": null
}
],
"sellers": "[Circular Reference]"
}
]
}
]
},
"modules": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"description": "text",
"isConfigurable": true,
"isEnabledByDefault": true,
"paid": true,
"name": "text",
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"sharedAccount": true,
"configurable": true,
"default": true,
"paid": true,
"type": [
"text"
]
},
"accountTypes": [
"text"
]
}
]
}OK
/v1/accounts/api-tokens/{id}/enable
curl -L \
--request POST \
--url '/v1/accounts/api-tokens/{id}/enable'{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"status": "text",
"name": "text",
"description": "text",
"icon": "text",
"lastAccessAt": "2025-02-22T08:44:15.727Z",
"token": "text",
"account": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"account": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
"[Circular Reference]"
]
},
"logo": "text",
"isDefault": true,
"modules": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"description": "text",
"isConfigurable": true,
"isEnabledByDefault": true,
"paid": true,
"name": "text",
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"sharedAccount": true,
"configurable": true,
"default": true,
"paid": true,
"type": [
"text"
]
},
"accountTypes": [
"text"
]
}
],
"users": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"icon": "text",
"lastLoginAt": "2025-02-22T08:44:15.727Z",
"settings": {
"cultureCode": "text",
"languageCode": "text"
},
"name": "text",
"currentAccount": "[Circular Reference]",
"accounts": "[Circular Reference]"
}
],
"buyers": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"contact": "[Circular Reference]",
"externalIds": {
"erpCompanyContact": "text",
"erpCustomer": "text",
"accountExternalId": "text"
},
"status": "Active",
"icon": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"taxId": "text",
"account": "[Circular Reference]",
"name": "text",
"errors": [
{
"id": "text",
"message": "text",
"parameters": null
}
],
"sellers": "[Circular Reference]"
}
]
}
]
},
"modules": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"description": "text",
"isConfigurable": true,
"isEnabledByDefault": true,
"paid": true,
"name": "text",
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"sharedAccount": true,
"configurable": true,
"default": true,
"paid": true,
"type": [
"text"
]
},
"accountTypes": [
"text"
]
}
]
}OK
/v1/accounts/api-tokens/{id}
curl -L \
--url '/v1/accounts/api-tokens/{id}'{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"status": "text",
"name": "text",
"description": "text",
"icon": "text",
"lastAccessAt": "2025-02-22T08:44:15.727Z",
"token": "text",
"account": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"account": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
"[Circular Reference]"
]
},
"logo": "text",
"isDefault": true,
"modules": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"description": "text",
"isConfigurable": true,
"isEnabledByDefault": true,
"paid": true,
"name": "text",
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"sharedAccount": true,
"configurable": true,
"default": true,
"paid": true,
"type": [
"text"
]
},
"accountTypes": [
"text"
]
}
],
"users": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"icon": "text",
"lastLoginAt": "2025-02-22T08:44:15.727Z",
"settings": {
"cultureCode": "text",
"languageCode": "text"
},
"name": "text",
"currentAccount": "[Circular Reference]",
"accounts": "[Circular Reference]"
}
],
"buyers": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"contact": "[Circular Reference]",
"externalIds": {
"erpCompanyContact": "text",
"erpCustomer": "text",
"accountExternalId": "text"
},
"status": "Active",
"icon": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"taxId": "text",
"account": "[Circular Reference]",
"name": "text",
"errors": [
{
"id": "text",
"message": "text",
"parameters": null
}
],
"sellers": "[Circular Reference]"
}
]
}
]
},
"modules": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"description": "text",
"isConfigurable": true,
"isEnabledByDefault": true,
"paid": true,
"name": "text",
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"sharedAccount": true,
"configurable": true,
"default": true,
"paid": true,
"type": [
"text"
]
},
"accountTypes": [
"text"
]
}
]
}OK
/v1/accounts/api-tokens
curl -L \
--url '/v1/accounts/api-tokens'{
"$meta": {
"pagination": {
"offset": 1,
"limit": 1,
"total": 1
},
"omitted": [
"text"
]
},
"data": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"status": "text",
"name": "text",
"description": "text",
"icon": "text",
"lastAccessAt": "2025-02-22T08:44:15.727Z",
"token": "text",
"account": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"account": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
"[Circular Reference]"
]
},
"logo": "text",
"isDefault": true,
"modules": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"description": "text",
"isConfigurable": true,
"isEnabledByDefault": true,
"paid": true,
"name": "text",
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"sharedAccount": true,
"configurable": true,
"default": true,
"paid": true,
"type": [
"text"
]
},
"accountTypes": [
"text"
]
}
],
"users": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"icon": "text",
"lastLoginAt": "2025-02-22T08:44:15.727Z",
"settings": {
"cultureCode": "text",
"languageCode": "text"
},
"name": "text",
"currentAccount": "[Circular Reference]",
"accounts": "[Circular Reference]"
}
],
"buyers": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"contact": "[Circular Reference]",
"externalIds": {
"erpCompanyContact": "text",
"erpCustomer": "text",
"accountExternalId": "text"
},
"status": "Active",
"icon": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"taxId": "text",
"account": "[Circular Reference]",
"name": "text",
"errors": [
{
"id": "text",
"message": "text",
"parameters": null
}
],
"sellers": "[Circular Reference]"
}
]
}
]
},
"modules": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"description": "text",
"isConfigurable": true,
"isEnabledByDefault": true,
"paid": true,
"name": "text",
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"sharedAccount": true,
"configurable": true,
"default": true,
"paid": true,
"type": [
"text"
]
},
"accountTypes": [
"text"
]
}
]
}
]
}OK
/v1/accounts/api-tokens/{id}
curl -L \
--request PUT \
--url '/v1/accounts/api-tokens/{id}' \
--header 'Content-Type: application/json' \
--data '{"modules":[{"id":"text"}]}'{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"status": "text",
"name": "text",
"description": "text",
"icon": "text",
"lastAccessAt": "2025-02-22T08:44:15.727Z",
"token": "text",
"account": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"account": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
"[Circular Reference]"
]
},
"logo": "text",
"isDefault": true,
"modules": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"description": "text",
"isConfigurable": true,
"isEnabledByDefault": true,
"paid": true,
"name": "text",
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"sharedAccount": true,
"configurable": true,
"default": true,
"paid": true,
"type": [
"text"
]
},
"accountTypes": [
"text"
]
}
],
"users": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"icon": "text",
"lastLoginAt": "2025-02-22T08:44:15.727Z",
"settings": {
"cultureCode": "text",
"languageCode": "text"
},
"name": "text",
"currentAccount": "[Circular Reference]",
"accounts": "[Circular Reference]"
}
],
"buyers": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"contact": "[Circular Reference]",
"externalIds": {
"erpCompanyContact": "text",
"erpCustomer": "text",
"accountExternalId": "text"
},
"status": "Active",
"icon": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"taxId": "text",
"account": "[Circular Reference]",
"name": "text",
"errors": [
{
"id": "text",
"message": "text",
"parameters": null
}
],
"sellers": "[Circular Reference]"
}
]
}
]
},
"modules": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"description": "text",
"isConfigurable": true,
"isEnabledByDefault": true,
"paid": true,
"name": "text",
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"sharedAccount": true,
"configurable": true,
"default": true,
"paid": true,
"type": [
"text"
]
},
"accountTypes": [
"text"
]
}
]
}OK
/v1/accounts/api-tokens
curl -L \
--request POST \
--url '/v1/accounts/api-tokens' \
--header 'Content-Type: application/json' \
--data '{"account":{"id":"text"},"modules":[{"id":"text"}]}'{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"status": "text",
"name": "text",
"description": "text",
"icon": "text",
"lastAccessAt": "2025-02-22T08:44:15.727Z",
"token": "text",
"account": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"description": "text",
"account": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"externalIds": {
"pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
},
"externalId": "text",
"externalName": "text",
"type": "Client",
"status": "Active",
"serviceLevel": "Express",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"icon": "text",
"technicalSupportEmail": "hello@example.com",
"website": "text",
"description": "text",
"name": "text",
"groups": [
"[Circular Reference]"
]
},
"logo": "text",
"isDefault": true,
"modules": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"description": "text",
"isConfigurable": true,
"isEnabledByDefault": true,
"paid": true,
"name": "text",
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"sharedAccount": true,
"configurable": true,
"default": true,
"paid": true,
"type": [
"text"
]
},
"accountTypes": [
"text"
]
}
],
"users": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"email": "text",
"status": "text",
"phone": {
"prefix": "text",
"number": "text"
},
"firstName": "text",
"lastName": "text",
"icon": "text",
"lastLoginAt": "2025-02-22T08:44:15.727Z",
"settings": {
"cultureCode": "text",
"languageCode": "text"
},
"name": "text",
"currentAccount": "[Circular Reference]",
"accounts": "[Circular Reference]"
}
],
"buyers": [
{
"id": "text",
"audit": "[Circular Reference]",
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"contact": "[Circular Reference]",
"externalIds": {
"erpCompanyContact": "text",
"erpCustomer": "text",
"accountExternalId": "text"
},
"status": "Active",
"icon": "text",
"address": {
"addressLine1": "text",
"addressLine2": "text",
"postCode": "text",
"city": "text",
"state": "text",
"country": "text"
},
"taxId": "text",
"account": "[Circular Reference]",
"name": "text",
"errors": [
{
"id": "text",
"message": "text",
"parameters": null
}
],
"sellers": "[Circular Reference]"
}
]
}
]
},
"modules": [
{
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": {
"id": "text",
"audit": {
"created": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"name": "text",
"icon": "text"
}
},
"updated": {
"at": "2025-02-22T08:44:15.727Z",
"by": "[Circular Reference]"
}
},
"$meta": {
"omitted": [
"text"
]
},
"href": "text",
"description": "text",
"isConfigurable": true,
"isEnabledByDefault": true,
"paid": true,
"name": "text",
"filters": {
"group.buyers": [
"text"
]
},
"settings": {
"sharedAccount": true,
"configurable": true,
"default": true,
"paid": true,
"type": [
"text"
]
},
"accountTypes": [
"text"
]
}
]
}Created
/v1/accounts/api-tokens/{id}
curl -L \
--request DELETE \
--url '/v1/accounts/api-tokens/{id}'No body
No Content
The token object represents an authentication token user in the Marketplace platform. This object contains the following properties:
id
string
Primary API token identifier.
Example: "TKN-1671-0642"
href
string
Relative reference to object on API.
Example: "/v1/accounts/accounts/ACC-1671-0642/tokens/TKN-4134-7330"
name
string
Name of the token.
Example: "Robot"
description
string
Token description.
Example: "Test token"
status
string
Status of the token: Active, Disabled, Deleted
modules
At least one modules validation when creating API Token.
account
Account under which the token has been defined.
Example:
{
"id": "ACC-123-123",
"name": "Microsoft"
}token
string
Authentication code.
{
"id": "TKN-4134-7330",
"href": "/v1/accounts/accounts/ACC-1671-0642/tokens/TKN-4134-7330",
"name": "Name",
"description": "Description",
"icon": "",
"status": "Active",
"modules": [
{
"id": "MOD-1756-1452"
},
{
"id": "MOD-9042-8216"
}
],
"token": "CODE"
}