Labels

Get an account's labels

get

This method returns the account's labels.

Authorizations
X-Ledger-API-KeystringRequired

If you've set up your API Key when initializing your LAM, you'll need to include it as a header along with the api user header. For more details, see step 5 of the get started documentation.

X-Ledger-API-UserstringRequired

(required) Username of a registered API User

Path parameters
account_idintegerRequired

The account's ID

Responses
chevron-right
200

Account object

application/json
get
/accounts/{account_id}/labels

Add a Label to the Account matching the ID

post

This post endpoint set the Label matching the ID passed in the payload to the Account matching the ID passed in the url

Authorizations
X-Ledger-API-KeystringRequired

If you've set up your API Key when initializing your LAM, you'll need to include it as a header along with the api user header. For more details, see step 5 of the get started documentation.

X-Ledger-API-UserstringRequired

(required) Username of a registered API User

Path parameters
account_idintegerRequired

The account's ID

Body
label_idintegerRequired

ID of the label to add to the resource

Example: 42
Responses
chevron-right
200

Whether or not the Label has been successfully attached

application/json
post
/accounts/{account_id}/labels

Remove a Label to the Account matching the ID

delete

This post endpoint remove the Label from the account matching the IDs passed in url

Authorizations
X-Ledger-API-KeystringRequired

If you've set up your API Key when initializing your LAM, you'll need to include it as a header along with the api user header. For more details, see step 5 of the get started documentation.

X-Ledger-API-UserstringRequired

(required) Username of a registered API User

Path parameters
account_idintegerRequired

The account's ID

label_idintegerRequired

The label's ID

Responses
chevron-right
200

Whether or not the Label has been successfully removed

application/json
delete
/accounts/{account_id}/labels/{label_id}