Retrieve Client by id
GET
clients/{clientId}
Fetches a single Client identified by the specified unique Client id.
Resource Information
| Method and URI | GET https://api.aps.autodesk.com/fusion-operations/v2/clients/{clientId} |
| Authentication Context | No security required |
| Required OAuth Scopes | data:read data:write |
| Data Format | JSON |
Request
Headers
| Authorization* string | JWT Access Token |
* Required
Request
URI Parameters
| clientId int | The unique identifier of the Client to retrieve. |
Response
HTTP Status Code Summary
| 200 OK | Client details retrieved successfully. |
| 401 Unauthorized | The access token is invalid. It may have either expired or may not be a three-legged access token. Please verify the token and retry the request. |
| 403 Forbidden | The request was successfully validated but lacked required permission. Please verify your token permissions and retry the request. |
| 404 Not Found | The resource in the path does not exist. |
| 429 Too Many Requests | Rate limit exceeded; wait some time before retrying. |
| 500 Internal Server Error | An unknown server-side error occurred. Please try again later. If the problem persists, please contact support. |
Response
Header (429)
| Retry-After integer | The number of seconds to wait before retrying the request. |
Response
Body Structure (200)
Expand all
| id int | Unique identifier of the client. |
| code string | Client code
Max length: 255 |
| name string | Client name |
| vatNumber string | Client VAT number |
| contacts array: object | Client contacts |
| id int | Unique identifier of the contact. |
| name string | Contact name |
| email string | Contact email |
| phoneNumber string | Contact phone number |
| default boolean | Is default contact |
| anyOf | |
| 0 | |
| 1 | |
| addresses array: object | Client addresses |
| id int | Unique identifier of the address. |
| code string | Address code
Max length: 255 |
| name string | Address name
Max length: 255 |
| city string | Address city
Max length: 255 |
| street string | Address street |
| postalCode string | Address postal code |
| state string | Address state
Max length: 255 |
| country string | Address country (ISO 3166-1 alpha-2 code) |
| default boolean | Is default address |
Example
Client details retrieved successfully.
Request
curl -v 'https://developer.api.autodesk.com/fusion-operations/v2/clients/:clientId' \
-H 'Authorization: '
Response
{
"id": 1,
"code": "Client code 1",
"name": "Client name 1",
"vatNumber": "Client VAT number 1",
"contacts": [
{
"id": 1,
"name": "Contact name 1",
"email": "contact1@example.com",
"phoneNumber": "123-456-7890",
"default": true
},
{
"id": 2,
"name": "Contact name 2",
"email": "contact2@example.com",
"phoneNumber": "234-567-8901",
"default": false
}
],
"addresses": [
{
"id": 1,
"code": "Address code 1",
"name": "Address name 1",
"city": "City 1",
"street": "Street 1",
"postalCode": "12345",
"state": "State 1",
"country": "PT",
"default": true
},
{
"id": 2,
"code": "Address code 2",
"name": "Address name 2",
"city": "City 2",
"street": "Street 2",
"postalCode": "67890",
"state": "State 2",
"country": "PT",
"default": false
}
]
}
Show More