v1
latestOpenAPI 3.0.02026-07-26254134307.1 KBAccounts
List Accounts
List the accounts of the company.
Required scope: accounts:read
get/accounts
Query parameters
limitinteger
Example:25
Max number of results per page
page_tokenstring
Example:https://yourCompany.api.frontapp.com/endpoint?limit=25&page_token=92f32bcd7625333caf4e0f8fc26d920c812f
Token to use to request the next page
sort_bystring
Field used to sort the accounts. Either created_at or updated_at.
sort_order'asc' | 'desc'
Example:asc
Order by which results should be sorted
Response
Array of accounts
Example response
{
"_pagination": {
"next": "https://yourCompany.api.frontapp.com/accounts?page_token=abae846b73ddd80f67fff73c491c41b8b0e74972f3a1079c3c8800416e06cf46"
},
"_links": {
"self": "https://yourCompany.api.frontapp.com/accounts"
},
"_results": [
{
"_links": {
"self": "https://yourCompany.api.frontapp.com/accounts/acc_76",
"related": {
"contacts": "https://yourCompany.api.frontapp.com/accounts/acc_76/contacts"
}
},
"id": "acc_76",
"name": "Dunder Mifflin, Inc.",
"logo_url": "https://yourCompany.api.frontapp.com/accounts/acc_aq/logo-1654309308278",
"description": "Limitless Paper in a Paperless World",
"custom_fields": {
"city": "London, UK",
"isVIP": true,
"renewal_date": 1525417200,
"sla_time": 90,
"owner": "leela@planet-express.com",
"replyTo": "inb_55c8c149",
"Job Title": "firefighter"
},
"created_at": 1622672452.363,
"updated_at": 1654309308.278
}
]
}