List

Preview
GET
https://api.senditly.ai/v1/accounts
List accounts
This API is in preview. It may be changed in the future.
List accounts
cURL
JavaScript
curl -X GET https://api.senditly.ai/v1/accounts \
     -H "Authorization: Bearer <API_KEY>" \
     -H "Content-Type: application/json"
try {
  const response = await fetch('https://api.senditly.ai/v1/accounts', {
     method: 'GET',
     headers: {
        Authorization: 'Bearer <API_KEY>',
     },
     body: JSON.stringify({ ... request json ... }),
  });
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
Headers
+-Hide 1 propertiesShow 1 properties
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Query
+-Hide 3 propertiesShow 3 properties
limit
integer
optional
A limit on the number of items to return. Defaults to 10. The value must be between 1 and 100.
startingAfter
string
optional
A cursor to start the list from. Defaults to the first item.
endingBefore
string
optional
A cursor to end the list at. Defaults to the last item.
Response
+-Hide 3 propertiesShow 3 properties
items
object[]
required
+-Hide 6 propertiesShow 6 properties
id
string
required
name
string
required
email
string
required
role
enum
required
The role of the account in the workspace.
createdAt
string
required
A date string in ISO 8601 format when the account was created.
updatedAt
string
required
A date string in ISO 8601 format when the account was last updated.
hasMore
boolean
required
Whether there are more items to fetch.
cursor
string
optional
A cursor to start the next list from.

Count

Preview
GET
https://api.senditly.ai/v1/accounts/count
Count accounts
This API is in preview. It may be changed in the future.
Count accounts
cURL
JavaScript
curl -X GET https://api.senditly.ai/v1/accounts/count \
     -H "Authorization: Bearer <API_KEY>" \
     -H "Content-Type: application/json"
try {
  const response = await fetch('https://api.senditly.ai/v1/accounts/count', {
     method: 'GET',
     headers: {
        Authorization: 'Bearer <API_KEY>',
     },
     body: JSON.stringify({ ... request json ... }),
  });
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
Headers
+-Hide 1 propertiesShow 1 properties
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Query
+-Hide 2 propertiesShow 2 properties
after
string
optional
A cursor to start the count from.
before
string
optional
A cursor to end the count at.
Response
+-Hide 1 propertiesShow 1 properties
count
integer
required
The total number of items.

ListByIds

Preview
POST
https://api.senditly.ai/v1/accounts/by_ids
List accounts by ids
This API is in preview. It may be changed in the future.
List accounts by ids
cURL
JavaScript
curl -X POST https://api.senditly.ai/v1/accounts/by_ids \
     -H "Authorization: Bearer <API_KEY>" \
     -H "Content-Type: application/json" \
     -d '{ ... request json ... }'
try {
  const response = await fetch('https://api.senditly.ai/v1/accounts/by_ids', {
     method: 'POST',
     headers: {
        Authorization: 'Bearer <API_KEY>',
        'Content-Type': 'application/json',
     },
     body: JSON.stringify({ ... request json ... }),
  });
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
Headers
+-Hide 1 propertiesShow 1 properties
Authorization
string
required
Bearer authentication of the form "Bearer <API_KEY>", where API_KEY is your api key.
Request
+-Hide 1 propertiesShow 1 properties
ids
string[]
required
string
Response
+-Hide 3 propertiesShow 3 properties
items
object[]
required
+-Hide 6 propertiesShow 6 properties
id
string
required
name
string
required
email
string
required
role
enum
required
The role of the account in the workspace.
createdAt
string
required
A date string in ISO 8601 format when the account was created.
updatedAt
string
required
A date string in ISO 8601 format when the account was last updated.
hasMore
boolean
required
Whether there are more items to fetch.
cursor
string
optional
A cursor to start the next list from.