Make requests to the API
api-key
issued by Smokeball and access_token
(see Authentication).
Make sure to include the appropriate scopes in your app settings before attempting any API requests.
Y2xpZW50X2lkOmNsaWV
Bearer
.Example: Bearer eyJraWQiOiJseVpBaHdjSW5UdVl6U...
limit
and offset
. These are used to control how many results are returned in a request that returns a list of results.
In the response above, you can see the details of the paging properties in the first section of the response:
Property | Description |
---|---|
offset | The number at which the results set begins |
limit | The number of results in the response |
size | The total number of results |
first | A link to the first result set |
next | A link to the next result set |
last | A link to the last result set |
By default, the limit
will be set to a maximum of 500 results.
accountId
in this format:
https://api.smokeball.com/{accountId}/{resource-path}Using the above contacts request as an example, the url is https://api.smokeball.com/contacts/ For a server-to-server request using the
accountId: ea4ca7b9-b826-4840-a8k5-94e6c6937c65
the request would be:
Note: all links in the repsonse will include the accountId prefix:
userId
associated with each request. A userId
is necessary for permission checking or ensuring that the UI reflects the change done by the specified user.
To act on behalf of a certain user simply supply the UserId
header with your requests. The value must be that of a User in the firm.
RequestId
header with your requests.
If the RequestId
header is supplied, it will be returned as a response header for every request you make. It will also be included in all webhook callbacks so you can track what data was impacted by your request.