Accounts

Accounts are your primary resource for configuring the Yardstik platform.
Use this to manage users, settings, and API keys.

List all accounts

List all accounts that you have access to.

SecurityApiKey
Request
query Parameters
order
string

Order listing results in ascending or descending order, when using order_by.
Accepted values are asc or desc. If not passed, defaults to ascending asc.

Examples:
order=desc
order_by
string

Order listing results by a specific property.

Examples:
order_by=created_at
page
integer

The page number to retrieve.

per_page
integer

The maximum number of results per page.

query
string

Filter listing results by a specific property.

Examples:
query[created_at_gteq]=2022-01-01T00:00:00.000Z
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/accounts
Request samples 
Response samples 
application/json
[
  • {
    }
]
Create an API key
Generate a new API key.


SecurityApiKey 
Request 
path Parameters
accountId
required
string
 
Request Body schema: application/json
name
string
The name of the API key


 
Responses 
201
Created


401
Unauthorized


403
Forbidden


404
Not Found


422
Unprocessable Entity


post/accounts/{accountId}/api_token
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "id": "70adc786-904b-4954-9adb-0ede9f949c62",
  • "api_token": "c6b6e55f-5b3a-479a-9ea8-d95d13856c7d",
  • "name": "Checking x",
  • "header": "Authorization: User c6b6e55f-5b3a-479a-9ea8-d95d13856c7d"
}
Get all settings
Account settings for a given account ID.


SecurityApiKey 
Request 
path Parameters
accountId
required
string
 
Responses 
200
OK


401
Unauthorized


404
Not Found


get/accounts/{accountId}/settings
Request samples 
Response samples 
application/json
{
  • "styles": {
    },
  • "invitations": {
    },
  • "adverse_actions": {
    },
  • "reports": {
    },
  • "report_notifications": {
    },
  • "info_request_notifications": {
    }
}
Get an account setting
Get a single account setting for the given account ID and setting key.


SecurityApiKey 
Request 
path Parameters
accountId
required
string
 
settingKey
required
string
e.g. styles, report_notifications, info_request_notifications


 
Responses 
200
OK


401
Unauthorized


404
Not Found


get/accounts/{accountId}/settings/{settingKey}
Request samples 
Response samples 
application/json
{
  • "primary_color": "FFCD01",
  • "secondary_color": "FFCD01"
}
Update an account setting
Update an account setting for the given account ID and setting key.


SecurityApiKey 
Request 
path Parameters
accountId
required
string
 
settingKey
required
string
e.g. styles, report_notifications, info_request_notifications


 
Request Body schema: application/json
object
 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


422
Unprocessable Entity


patch/accounts/{accountId}/settings/{settingKey}
Request samples 
application/json
{
  • "primary_color": "FFCD01"
}
Response samples 
application/json
{ }
Get an account
Account details.


SecurityApiKey 
Request 
path Parameters
accountId
required
string
 
Responses 
200
OK


201
Created


400
Bad Request


401
Unauthorized


404
Not Found


get/accounts/{accountId}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "account_name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email_address": "user@example.com",
  • "url": "string",
  • "tech_email_address": "user@example.com",
  • "support_email_address": "user@example.com",
  • "support_phone": "string",
  • "compliance_email_address": "user@example.com",
  • "actions_email_address": "user@example.com",
  • "configurations": {
    },
  • "features": {
    },
  • "company_phone_number": "string",
  • "additional_company_info": "string",
  • "owner_title": "string",
  • "legal_business_name": "string",
  • "state_of_incorporation": "string",
  • "ein": "string",
  • "legal_entity_type": "string",
  • "billing_contact_first_name": "string",
  • "billing_contact_last_name": "string",
  • "billing_email": "string",
  • "address": {
    },
  • "logo": "string",
  • "meta": {
    },
  • "permissible_purposes": [
    ]
}
➔ Next to Subaccounts