Retrieve Suppliers
GET
suppliers
Retrieves a paginated list of all Suppliers, optionally filtered and sorted. When additional results are available, the pagination object in the response payload provides a “nextUrl” that links to the next page of results.
Resource Information
| Method and URI | GET https://api.aps.autodesk.com/fusion-operations/v2/suppliers |
| Authentication Context | No security required |
| Required OAuth Scopes | data:read data:write |
| Data Format | JSON |
Request
Headers
| Authorization* string | JWT Access Token |
* Required
Request
Query String Parameters
| filter[id] int | Filter Suppliers matching the specified id. |
| filter[code] string | Filter Suppliers matching the specified code. Pass the value as URL‑encoded. |
| offset int | Page offset. Default value is 0. |
| limit int | Maximum number of results returned. Defaults to 25. |
| sort string | Comma separated fields to sort items by. Fields: id, code. Default: “id desc”. |
Response
HTTP Status Code Summary
| 200 OK | A list of suppliers. |
| 400 Bad Request | Bad request due to invalid data. |
| 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. |
| 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
| results array: object | List of suppliers |
| id int | Unique identifier of the supplier. |
| code string | Supplier code
Max length: 255 |
| name string | Supplier name |
| vatNumber string | Supplier VAT number |
| expirationDate string | Supplier expiration date (ISO 8601 date, e.g. 2017-06-21) |
| contacts array: object | Supplier 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 | Supplier 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 |
| pagination object | |
| limit int | Maximum number of results returned in this page. |
| offset int | Number of results skipped before this page. |
| nextUrl string | URL for the next page of results. Null when there are no additional pages. |
Example
A list of suppliers.
Request
curl -v 'https://developer.api.autodesk.com/fusion-operations/v2/suppliers' \
-H 'Authorization: '
Response
{
"results": [
{
"id": 1,
"code": "Supplier code 1",
"name": "Supplier name 1",
"vatNumber": "Supplier VAT number 1",
"expirationDate": "2025-01-20",
"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
}
]
}
],
"pagination": {
"limit": 20,
"offset": 0,
"nextUrl": null
}
}
Show More