TeamPaths
Defined in: src/team/types.gen.ts:2
Properties
Section titled “Properties”/v2/cards
Section titled “/v2/cards”/v2/cards:
object
Defined in: src/team/types.gen.ts:3
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
List cards
Description
Section titled “Description”Lists all cards by a user_id.
Only cards with limit_type = CARD have spend_controls
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path?
Section titled “get.parameters.path?”
optionalpath?:undefined
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:object
get.parameters.query.cursor?
Section titled “get.parameters.query.cursor?”
optionalcursor?:string|null
get.parameters.query.limit?
Section titled “get.parameters.query.limit?”
optionallimit?:number|null
get.parameters.query.user_id?
Section titled “get.parameters.query.user_id?”
optionaluser_id?:string|null
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”listCardsByUserId 200 response
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.items
Section titled “get.responses.200.content.application/json.items”items:
object[]
get.responses.200.content.application/json.next_cursor?
Section titled “get.responses.200.content.application/json.next_cursor?”
optionalnext_cursor?:string|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Create card
Description
Section titled “Description”Creates a new card.
The spend_controls field is required when limit_type = CARD.
The mailing_address field is required for physical cards and is the shipping address used to send the card; it is not the same as the billing and mailing address used for online purchases.
The first 2 lines of this address must be under 60 characters long. Each user can only have up to 10 active physical cards.
For Empower accounts, this endpoint requires budget management. If your account does not have access to budget management features, a 403 response status will be returned.
If this is the case and you want to gain access to this endpoint, please contact Brex support.
post.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header
Section titled “post.parameters.header”header:
object
post.parameters.header.Idempotency-Key
Section titled “post.parameters.header.Idempotency-Key”Idempotency-Key:
string
post.parameters.path?
Section titled “post.parameters.path?”
optionalpath?:undefined
post.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody
Section titled “post.requestBody”requestBody:
object
post.requestBody.content
Section titled “post.requestBody.content”content:
object
post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”application/json:
object
post.requestBody.content.application/json.card_attribute_preferences?
Section titled “post.requestBody.content.application/json.card_attribute_preferences?”
optionalcard_attribute_preferences?: {three_domain_secure_enabled_preference?:"THREE_DOMAIN_SECURE_ENABLED"|"THREE_DOMAIN_SECURE_DISABLED"|null; } |null
post.requestBody.content.application/json.card_name
Section titled “post.requestBody.content.application/json.card_name”card_name:
string
post.requestBody.content.application/json.card_type
Section titled “post.requestBody.content.application/json.card_type”card_type:
"VIRTUAL"|"PHYSICAL"
post.requestBody.content.application/json.limit_type
Section titled “post.requestBody.content.application/json.limit_type”limit_type:
"CARD"|"USER"
post.requestBody.content.application/json.mailing_address?
Section titled “post.requestBody.content.application/json.mailing_address?”
optionalmailing_address?: {city?:string|null;country?:string|null;line1?:string|null;line2?:string|null;phone_number?:string|null;postal_code?:string|null;state?:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ city?: string | null; country?: string | null; line1?: string | null; line2?: string | null; phone_number?: string | null; postal_code?: string | null; state?: string | null; }
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
country?
Section titled “country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
line1?
Section titled “line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
line2?
Section titled “line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
phone_number?
Section titled “phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
postal_code?
Section titled “postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
state?
Section titled “state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
null
post.requestBody.content.application/json.metadata?
Section titled “post.requestBody.content.application/json.metadata?”
optionalmetadata?: {[key:string]:string; } |null
Description
Section titled “Description”Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters.
post.requestBody.content.application/json.owner
Section titled “post.requestBody.content.application/json.owner”owner:
object&object
Type Declaration
Section titled “Type Declaration”type:
"USER"
user_id
Section titled “user_id”user_id:
string
Type Declaration
Section titled “Type Declaration”type:
"USER"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
post.requestBody.content.application/json.spend_controls?
Section titled “post.requestBody.content.application/json.spend_controls?”
optionalspend_controls?: {allowed_merchant_details?:object[] |null;blocked_merchant_details?:object[] |null;lock_after_date?:string|null;parent_budget_id?:string|null;policy_id?:string|null;reason?:string|null;spend_duration:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME";spend_limit: {amount:number;currency:string|null; }; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ allowed_merchant_details?: object[] | null; blocked_merchant_details?: object[] | null; lock_after_date?: string | null; parent_budget_id?: string | null; policy_id?: string | null; reason?: string | null; spend_duration: "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME"; spend_limit: { amount: number; currency: string | null; }; }
allowed_merchant_details?
Section titled “allowed_merchant_details?”
optionalallowed_merchant_details?:object[] |null
Description
Section titled “Description”List of merchants where card transactions are allowed. Cannot be used together with blocked_merchant_details. Maximum 50 merchant details.
Example
Section titled “Example”[{"name": "Github"}, {"name": "AWS"}]blocked_merchant_details?
Section titled “blocked_merchant_details?”
optionalblocked_merchant_details?:object[] |null
Description
Section titled “Description”List of merchants where card transactions are blocked. Cannot be used together with allowed_merchant_details. Maximum 50 merchant details.
Example
Section titled “Example”[{"name": "Apple"}, {"name": "Amazon"}]lock_after_date?
Section titled “lock_after_date?”
optionallock_after_date?:string|null
Format: date
parent_budget_id?
Section titled “parent_budget_id?”
optionalparent_budget_id?:string|null
Description
Section titled “Description”If using the Empower platform, a new budget will be created for this card. You can specify a parent_budget that your new
budget will be nested under. If parent_budget_id is null, we will nest the new budget under the top-level account budget.
policy_id?
Section titled “policy_id?”
optionalpolicy_id?:string|null
reason?
Section titled “reason?”
optionalreason?:string|null
spend_duration
Section titled “spend_duration”spend_duration:
"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"
spend_limit
Section titled “spend_limit”spend_limit:
object
spend_limit.amount
Section titled “spend_limit.amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700spend_limit.currency
Section titled “spend_limit.currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
post.responses
Section titled “post.responses”responses:
object
post.responses.200
Section titled “post.responses.200”200:
object
Description
Section titled “Description”createCard 200 response
post.responses.200.content
Section titled “post.responses.200.content”content:
object
post.responses.200.content.application/json
Section titled “post.responses.200.content.application/json”application/json:
object
post.responses.200.content.application/json.billing_address
Section titled “post.responses.200.content.application/json.billing_address”billing_address:
object
post.responses.200.content.application/json.billing_address.city?
Section titled “post.responses.200.content.application/json.billing_address.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
post.responses.200.content.application/json.billing_address.country?
Section titled “post.responses.200.content.application/json.billing_address.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
post.responses.200.content.application/json.billing_address.line1?
Section titled “post.responses.200.content.application/json.billing_address.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
post.responses.200.content.application/json.billing_address.line2?
Section titled “post.responses.200.content.application/json.billing_address.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
post.responses.200.content.application/json.billing_address.phone_number?
Section titled “post.responses.200.content.application/json.billing_address.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
post.responses.200.content.application/json.billing_address.postal_code?
Section titled “post.responses.200.content.application/json.billing_address.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
post.responses.200.content.application/json.billing_address.state?
Section titled “post.responses.200.content.application/json.billing_address.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
post.responses.200.content.application/json.budget_id?
Section titled “post.responses.200.content.application/json.budget_id?”
optionalbudget_id?:string|null
post.responses.200.content.application/json.card_name
Section titled “post.responses.200.content.application/json.card_name”card_name:
string
post.responses.200.content.application/json.card_type?
Section titled “post.responses.200.content.application/json.card_type?”
optionalcard_type?:"VIRTUAL"|"PHYSICAL"|null
post.responses.200.content.application/json.expiration_date
Section titled “post.responses.200.content.application/json.expiration_date”expiration_date:
object
post.responses.200.content.application/json.expiration_date.month
Section titled “post.responses.200.content.application/json.expiration_date.month”month:
number
Format: int32
post.responses.200.content.application/json.expiration_date.year
Section titled “post.responses.200.content.application/json.expiration_date.year”year:
number
Format: int32
post.responses.200.content.application/json.has_been_transferred?
Section titled “post.responses.200.content.application/json.has_been_transferred?”
optionalhas_been_transferred?:boolean
Description
Section titled “Description”Indicates whether a card has been transferred. Transferred cards have a spending restriction: we only allow transactions
at online vendors where this card was previously used before the transfer.
post.responses.200.content.application/json.id
Section titled “post.responses.200.content.application/json.id”id:
string
post.responses.200.content.application/json.last_four
Section titled “post.responses.200.content.application/json.last_four”last_four:
string
post.responses.200.content.application/json.limit_type
Section titled “post.responses.200.content.application/json.limit_type”limit_type:
"CARD"|"USER"
post.responses.200.content.application/json.mailing_address?
Section titled “post.responses.200.content.application/json.mailing_address?”
optionalmailing_address?: {city?:string|null;country?:string|null;line1?:string|null;line2?:string|null;phone_number?:string|null;postal_code?:string|null;state?:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ city?: string | null; country?: string | null; line1?: string | null; line2?: string | null; phone_number?: string | null; postal_code?: string | null; state?: string | null; }
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
country?
Section titled “country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
line1?
Section titled “line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
line2?
Section titled “line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
phone_number?
Section titled “phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
postal_code?
Section titled “postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
state?
Section titled “state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
null
post.responses.200.content.application/json.metadata?
Section titled “post.responses.200.content.application/json.metadata?”
optionalmetadata?: {[key:string]:string; } |null
Description
Section titled “Description”Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters.
post.responses.200.content.application/json.owner
Section titled “post.responses.200.content.application/json.owner”owner:
object&object
Type Declaration
Section titled “Type Declaration”type:
"USER"
user_id
Section titled “user_id”user_id:
string
Type Declaration
Section titled “Type Declaration”type:
"USER"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
post.responses.200.content.application/json.spend_controls?
Section titled “post.responses.200.content.application/json.spend_controls?”
optionalspend_controls?: {allowed_merchant_details?:object[] |null;blocked_merchant_details?:object[] |null;lock_after_date?:string|null;reason?:string|null;spend_available?: {amount:number;currency: … | …; } |null;spend_duration?:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null;spend_limit?: {amount:number;currency: … | …; } |null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ allowed_merchant_details?: object[] | null; blocked_merchant_details?: object[] | null; lock_after_date?: string | null; reason?: string | null; spend_available?: { amount: number; currency: … | …; } | null; spend_duration?: "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME" | null; spend_limit?: { amount: number; currency: … | …; } | null; }
allowed_merchant_details?
Section titled “allowed_merchant_details?”
optionalallowed_merchant_details?:object[] |null
Description
Section titled “Description”List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured.
Example
Section titled “Example”[{"name": "Github"}, {"name": "AWS"}]blocked_merchant_details?
Section titled “blocked_merchant_details?”
optionalblocked_merchant_details?:object[] |null
Description
Section titled “Description”List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured.
Example
Section titled “Example”[{"name": "Apple"}, {"name": "Amazon"}]lock_after_date?
Section titled “lock_after_date?”
optionallock_after_date?:string|null
Format: date
Description
Section titled “Description”The lock_after_date is in UTC.
reason?
Section titled “reason?”
optionalreason?:string|null
spend_available?
Section titled “spend_available?”
optionalspend_available?: {amount:number;currency: … | …; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: … | …; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency: … | …
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
spend_duration?
Section titled “spend_duration?”
optionalspend_duration?:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null
spend_limit?
Section titled “spend_limit?”
optionalspend_limit?: {amount:number;currency: … | …; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: … | …; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency: … | …
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
null
post.responses.200.content.application/json.status?
Section titled “post.responses.200.content.application/json.status?”
optionalstatus?:"ACTIVE"|"TERMINATED"|"SHIPPED"|"LOCKED"|null
post.responses.200.headers
Section titled “post.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v2/cards/{id}
Section titled “/v2/cards/{id}”/v2/cards/{id}:
object
Defined in: src/team/types.gen.ts:33
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
Get card
Description
Section titled “Description”Retrieves a card by ID. Only cards with limit_type = CARD have spend_controls
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path
Section titled “get.parameters.path”path:
object
get.parameters.path.id
Section titled “get.parameters.path.id”id:
string
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:undefined
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”getCardById 200 response
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.billing_address
Section titled “get.responses.200.content.application/json.billing_address”billing_address:
object
get.responses.200.content.application/json.billing_address.city?
Section titled “get.responses.200.content.application/json.billing_address.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
get.responses.200.content.application/json.billing_address.country?
Section titled “get.responses.200.content.application/json.billing_address.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
get.responses.200.content.application/json.billing_address.line1?
Section titled “get.responses.200.content.application/json.billing_address.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
get.responses.200.content.application/json.billing_address.line2?
Section titled “get.responses.200.content.application/json.billing_address.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
get.responses.200.content.application/json.billing_address.phone_number?
Section titled “get.responses.200.content.application/json.billing_address.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
get.responses.200.content.application/json.billing_address.postal_code?
Section titled “get.responses.200.content.application/json.billing_address.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
get.responses.200.content.application/json.billing_address.state?
Section titled “get.responses.200.content.application/json.billing_address.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
get.responses.200.content.application/json.budget_id?
Section titled “get.responses.200.content.application/json.budget_id?”
optionalbudget_id?:string|null
get.responses.200.content.application/json.card_name
Section titled “get.responses.200.content.application/json.card_name”card_name:
string
get.responses.200.content.application/json.card_type?
Section titled “get.responses.200.content.application/json.card_type?”
optionalcard_type?:"VIRTUAL"|"PHYSICAL"|null
get.responses.200.content.application/json.expiration_date
Section titled “get.responses.200.content.application/json.expiration_date”expiration_date:
object
get.responses.200.content.application/json.expiration_date.month
Section titled “get.responses.200.content.application/json.expiration_date.month”month:
number
Format: int32
get.responses.200.content.application/json.expiration_date.year
Section titled “get.responses.200.content.application/json.expiration_date.year”year:
number
Format: int32
get.responses.200.content.application/json.has_been_transferred?
Section titled “get.responses.200.content.application/json.has_been_transferred?”
optionalhas_been_transferred?:boolean
Description
Section titled “Description”Indicates whether a card has been transferred. Transferred cards have a spending restriction: we only allow transactions
at online vendors where this card was previously used before the transfer.
get.responses.200.content.application/json.id
Section titled “get.responses.200.content.application/json.id”id:
string
get.responses.200.content.application/json.last_four
Section titled “get.responses.200.content.application/json.last_four”last_four:
string
get.responses.200.content.application/json.limit_type
Section titled “get.responses.200.content.application/json.limit_type”limit_type:
"CARD"|"USER"
get.responses.200.content.application/json.mailing_address?
Section titled “get.responses.200.content.application/json.mailing_address?”
optionalmailing_address?: {city?:string|null;country?:string|null;line1?:string|null;line2?:string|null;phone_number?:string|null;postal_code?:string|null;state?:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ city?: string | null; country?: string | null; line1?: string | null; line2?: string | null; phone_number?: string | null; postal_code?: string | null; state?: string | null; }
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
country?
Section titled “country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
line1?
Section titled “line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
line2?
Section titled “line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
phone_number?
Section titled “phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
postal_code?
Section titled “postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
state?
Section titled “state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
null
get.responses.200.content.application/json.metadata?
Section titled “get.responses.200.content.application/json.metadata?”
optionalmetadata?: {[key:string]:string; } |null
Description
Section titled “Description”Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters.
get.responses.200.content.application/json.owner
Section titled “get.responses.200.content.application/json.owner”owner:
object&object
Type Declaration
Section titled “Type Declaration”type:
"USER"
user_id
Section titled “user_id”user_id:
string
Type Declaration
Section titled “Type Declaration”type:
"USER"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
get.responses.200.content.application/json.spend_controls?
Section titled “get.responses.200.content.application/json.spend_controls?”
optionalspend_controls?: {allowed_merchant_details?:object[] |null;blocked_merchant_details?:object[] |null;lock_after_date?:string|null;reason?:string|null;spend_available?: {amount:number;currency: … | …; } |null;spend_duration?:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null;spend_limit?: {amount:number;currency: … | …; } |null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ allowed_merchant_details?: object[] | null; blocked_merchant_details?: object[] | null; lock_after_date?: string | null; reason?: string | null; spend_available?: { amount: number; currency: … | …; } | null; spend_duration?: "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME" | null; spend_limit?: { amount: number; currency: … | …; } | null; }
allowed_merchant_details?
Section titled “allowed_merchant_details?”
optionalallowed_merchant_details?:object[] |null
Description
Section titled “Description”List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured.
Example
Section titled “Example”[{"name": "Github"}, {"name": "AWS"}]blocked_merchant_details?
Section titled “blocked_merchant_details?”
optionalblocked_merchant_details?:object[] |null
Description
Section titled “Description”List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured.
Example
Section titled “Example”[{"name": "Apple"}, {"name": "Amazon"}]lock_after_date?
Section titled “lock_after_date?”
optionallock_after_date?:string|null
Format: date
Description
Section titled “Description”The lock_after_date is in UTC.
reason?
Section titled “reason?”
optionalreason?:string|null
spend_available?
Section titled “spend_available?”
optionalspend_available?: {amount:number;currency: … | …; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: … | …; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency: … | …
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
spend_duration?
Section titled “spend_duration?”
optionalspend_duration?:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null
spend_limit?
Section titled “spend_limit?”
optionalspend_limit?: {amount:number;currency: … | …; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: … | …; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency: … | …
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
null
get.responses.200.content.application/json.status?
Section titled “get.responses.200.content.application/json.status?”
optionalstatus?:"ACTIVE"|"TERMINATED"|"SHIPPED"|"LOCKED"|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
put:
object
Update card
Description
Section titled “Description”Update an existing vendor card
put.parameters
Section titled “put.parameters”parameters:
object
put.parameters.cookie?
Section titled “put.parameters.cookie?”
optionalcookie?:undefined
put.parameters.header?
Section titled “put.parameters.header?”
optionalheader?:object
put.parameters.header.Idempotency-Key?
Section titled “put.parameters.header.Idempotency-Key?”
optionalIdempotency-Key?:string|null
put.parameters.path
Section titled “put.parameters.path”path:
object
put.parameters.path.id
Section titled “put.parameters.path.id”id:
string
put.parameters.query?
Section titled “put.parameters.query?”
optionalquery?:undefined
put.requestBody
Section titled “put.requestBody”requestBody:
object
put.requestBody.content
Section titled “put.requestBody.content”content:
object
put.requestBody.content.application/json
Section titled “put.requestBody.content.application/json”application/json:
object
put.requestBody.content.application/json.metadata?
Section titled “put.requestBody.content.application/json.metadata?”
optionalmetadata?: {[key:string]:string; } |null
Description
Section titled “Description”Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters.
put.requestBody.content.application/json.spend_controls?
Section titled “put.requestBody.content.application/json.spend_controls?”
optionalspend_controls?: {allowed_merchant_details?:object[] |null;blocked_merchant_details?:object[] |null;lock_after_date?:string|null;reason?:string|null;spend_duration?:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null;spend_limit?: {amount:number;currency:string|null; } |null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ allowed_merchant_details?: object[] | null; blocked_merchant_details?: object[] | null; lock_after_date?: string | null; reason?: string | null; spend_duration?: "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME" | null; spend_limit?: { amount: number; currency: string | null; } | null; }
allowed_merchant_details?
Section titled “allowed_merchant_details?”
optionalallowed_merchant_details?:object[] |null
Description
Section titled “Description”List of merchants where card transactions are allowed. Cannot be used together with blocked_merchant_details. Maximum 50 merchant details.
Example
Section titled “Example”[{"name": "Github"}, {"name": "AWS"}]blocked_merchant_details?
Section titled “blocked_merchant_details?”
optionalblocked_merchant_details?:object[] |null
Description
Section titled “Description”List of merchants where card transactions are blocked. Cannot be used together with allowed_merchant_details. Maximum 50 merchant details.
Example
Section titled “Example”[{"name": "Apple"}, {"name": "Amazon"}]lock_after_date?
Section titled “lock_after_date?”
optionallock_after_date?:string|null
Format: date
reason?
Section titled “reason?”
optionalreason?:string|null
spend_duration?
Section titled “spend_duration?”
optionalspend_duration?:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null
spend_limit?
Section titled “spend_limit?”
optionalspend_limit?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
null
put.responses
Section titled “put.responses”responses:
object
put.responses.200
Section titled “put.responses.200”200:
object
Description
Section titled “Description”updateCard 200 response
put.responses.200.content
Section titled “put.responses.200.content”content:
object
put.responses.200.content.application/json
Section titled “put.responses.200.content.application/json”application/json:
object
put.responses.200.content.application/json.billing_address
Section titled “put.responses.200.content.application/json.billing_address”billing_address:
object
put.responses.200.content.application/json.billing_address.city?
Section titled “put.responses.200.content.application/json.billing_address.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
put.responses.200.content.application/json.billing_address.country?
Section titled “put.responses.200.content.application/json.billing_address.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
put.responses.200.content.application/json.billing_address.line1?
Section titled “put.responses.200.content.application/json.billing_address.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
put.responses.200.content.application/json.billing_address.line2?
Section titled “put.responses.200.content.application/json.billing_address.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
put.responses.200.content.application/json.billing_address.phone_number?
Section titled “put.responses.200.content.application/json.billing_address.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
put.responses.200.content.application/json.billing_address.postal_code?
Section titled “put.responses.200.content.application/json.billing_address.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
put.responses.200.content.application/json.billing_address.state?
Section titled “put.responses.200.content.application/json.billing_address.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
put.responses.200.content.application/json.budget_id?
Section titled “put.responses.200.content.application/json.budget_id?”
optionalbudget_id?:string|null
put.responses.200.content.application/json.card_name
Section titled “put.responses.200.content.application/json.card_name”card_name:
string
put.responses.200.content.application/json.card_type?
Section titled “put.responses.200.content.application/json.card_type?”
optionalcard_type?:"VIRTUAL"|"PHYSICAL"|null
put.responses.200.content.application/json.expiration_date
Section titled “put.responses.200.content.application/json.expiration_date”expiration_date:
object
put.responses.200.content.application/json.expiration_date.month
Section titled “put.responses.200.content.application/json.expiration_date.month”month:
number
Format: int32
put.responses.200.content.application/json.expiration_date.year
Section titled “put.responses.200.content.application/json.expiration_date.year”year:
number
Format: int32
put.responses.200.content.application/json.has_been_transferred?
Section titled “put.responses.200.content.application/json.has_been_transferred?”
optionalhas_been_transferred?:boolean
Description
Section titled “Description”Indicates whether a card has been transferred. Transferred cards have a spending restriction: we only allow transactions
at online vendors where this card was previously used before the transfer.
put.responses.200.content.application/json.id
Section titled “put.responses.200.content.application/json.id”id:
string
put.responses.200.content.application/json.last_four
Section titled “put.responses.200.content.application/json.last_four”last_four:
string
put.responses.200.content.application/json.limit_type
Section titled “put.responses.200.content.application/json.limit_type”limit_type:
"CARD"|"USER"
put.responses.200.content.application/json.mailing_address?
Section titled “put.responses.200.content.application/json.mailing_address?”
optionalmailing_address?: {city?:string|null;country?:string|null;line1?:string|null;line2?:string|null;phone_number?:string|null;postal_code?:string|null;state?:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ city?: string | null; country?: string | null; line1?: string | null; line2?: string | null; phone_number?: string | null; postal_code?: string | null; state?: string | null; }
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
country?
Section titled “country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
line1?
Section titled “line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
line2?
Section titled “line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
phone_number?
Section titled “phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
postal_code?
Section titled “postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
state?
Section titled “state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
null
put.responses.200.content.application/json.metadata?
Section titled “put.responses.200.content.application/json.metadata?”
optionalmetadata?: {[key:string]:string; } |null
Description
Section titled “Description”Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters.
put.responses.200.content.application/json.owner
Section titled “put.responses.200.content.application/json.owner”owner:
object&object
Type Declaration
Section titled “Type Declaration”type:
"USER"
user_id
Section titled “user_id”user_id:
string
Type Declaration
Section titled “Type Declaration”type:
"USER"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
put.responses.200.content.application/json.spend_controls?
Section titled “put.responses.200.content.application/json.spend_controls?”
optionalspend_controls?: {allowed_merchant_details?:object[] |null;blocked_merchant_details?:object[] |null;lock_after_date?:string|null;reason?:string|null;spend_available?: {amount:number;currency: … | …; } |null;spend_duration?:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null;spend_limit?: {amount:number;currency: … | …; } |null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ allowed_merchant_details?: object[] | null; blocked_merchant_details?: object[] | null; lock_after_date?: string | null; reason?: string | null; spend_available?: { amount: number; currency: … | …; } | null; spend_duration?: "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME" | null; spend_limit?: { amount: number; currency: … | …; } | null; }
allowed_merchant_details?
Section titled “allowed_merchant_details?”
optionalallowed_merchant_details?:object[] |null
Description
Section titled “Description”List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured.
Example
Section titled “Example”[{"name": "Github"}, {"name": "AWS"}]blocked_merchant_details?
Section titled “blocked_merchant_details?”
optionalblocked_merchant_details?:object[] |null
Description
Section titled “Description”List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured.
Example
Section titled “Example”[{"name": "Apple"}, {"name": "Amazon"}]lock_after_date?
Section titled “lock_after_date?”
optionallock_after_date?:string|null
Format: date
Description
Section titled “Description”The lock_after_date is in UTC.
reason?
Section titled “reason?”
optionalreason?:string|null
spend_available?
Section titled “spend_available?”
optionalspend_available?: {amount:number;currency: … | …; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: … | …; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency: … | …
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
spend_duration?
Section titled “spend_duration?”
optionalspend_duration?:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null
spend_limit?
Section titled “spend_limit?”
optionalspend_limit?: {amount:number;currency: … | …; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: … | …; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency: … | …
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
null
put.responses.200.content.application/json.status?
Section titled “put.responses.200.content.application/json.status?”
optionalstatus?:"ACTIVE"|"TERMINATED"|"SHIPPED"|"LOCKED"|null
put.responses.200.headers
Section titled “put.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
trace?
Section titled “trace?”
optionaltrace?:undefined
/v2/cards/{id}/lock
Section titled “/v2/cards/{id}/lock”/v2/cards/{id}/lock:
object
Defined in: src/team/types.gen.ts:57
delete?
Section titled “delete?”
optionaldelete?:undefined
optionalget?:undefined
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Lock card
Description
Section titled “Description”Locks an existing, unlocked card. And the card owner will receive a notification about it.
post.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header?
Section titled “post.parameters.header?”
optionalheader?:object
post.parameters.header.Idempotency-Key?
Section titled “post.parameters.header.Idempotency-Key?”
optionalIdempotency-Key?:string|null
post.parameters.path
Section titled “post.parameters.path”path:
object
post.parameters.path.id
Section titled “post.parameters.path.id”id:
string
post.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody
Section titled “post.requestBody”requestBody:
object
post.requestBody.content
Section titled “post.requestBody.content”content:
object
post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”application/json:
object
post.requestBody.content.application/json.description?
Section titled “post.requestBody.content.application/json.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description for locking a card
post.requestBody.content.application/json.reason
Section titled “post.requestBody.content.application/json.reason”reason:
"OTHER"|"CARD_DAMAGED"|"CARD_LOST"|"CARD_NOT_RECEIVED"|"DO_NOT_NEED_PHYSICAL_CARD"|"DO_NOT_NEED_VIRTUAL_CARD"|"FRAUD"
post.responses
Section titled “post.responses”responses:
object
post.responses.200
Section titled “post.responses.200”200:
object
Description
Section titled “Description”lockCard 200 response
post.responses.200.content
Section titled “post.responses.200.content”content:
object
post.responses.200.content.application/json
Section titled “post.responses.200.content.application/json”application/json:
object
post.responses.200.content.application/json.billing_address
Section titled “post.responses.200.content.application/json.billing_address”billing_address:
object
post.responses.200.content.application/json.billing_address.city?
Section titled “post.responses.200.content.application/json.billing_address.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
post.responses.200.content.application/json.billing_address.country?
Section titled “post.responses.200.content.application/json.billing_address.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
post.responses.200.content.application/json.billing_address.line1?
Section titled “post.responses.200.content.application/json.billing_address.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
post.responses.200.content.application/json.billing_address.line2?
Section titled “post.responses.200.content.application/json.billing_address.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
post.responses.200.content.application/json.billing_address.phone_number?
Section titled “post.responses.200.content.application/json.billing_address.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
post.responses.200.content.application/json.billing_address.postal_code?
Section titled “post.responses.200.content.application/json.billing_address.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
post.responses.200.content.application/json.billing_address.state?
Section titled “post.responses.200.content.application/json.billing_address.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
post.responses.200.content.application/json.budget_id?
Section titled “post.responses.200.content.application/json.budget_id?”
optionalbudget_id?:string|null
post.responses.200.content.application/json.card_name
Section titled “post.responses.200.content.application/json.card_name”card_name:
string
post.responses.200.content.application/json.card_type?
Section titled “post.responses.200.content.application/json.card_type?”
optionalcard_type?:"VIRTUAL"|"PHYSICAL"|null
post.responses.200.content.application/json.expiration_date
Section titled “post.responses.200.content.application/json.expiration_date”expiration_date:
object
post.responses.200.content.application/json.expiration_date.month
Section titled “post.responses.200.content.application/json.expiration_date.month”month:
number
Format: int32
post.responses.200.content.application/json.expiration_date.year
Section titled “post.responses.200.content.application/json.expiration_date.year”year:
number
Format: int32
post.responses.200.content.application/json.has_been_transferred?
Section titled “post.responses.200.content.application/json.has_been_transferred?”
optionalhas_been_transferred?:boolean
Description
Section titled “Description”Indicates whether a card has been transferred. Transferred cards have a spending restriction: we only allow transactions
at online vendors where this card was previously used before the transfer.
post.responses.200.content.application/json.id
Section titled “post.responses.200.content.application/json.id”id:
string
post.responses.200.content.application/json.last_four
Section titled “post.responses.200.content.application/json.last_four”last_four:
string
post.responses.200.content.application/json.limit_type
Section titled “post.responses.200.content.application/json.limit_type”limit_type:
"CARD"|"USER"
post.responses.200.content.application/json.mailing_address?
Section titled “post.responses.200.content.application/json.mailing_address?”
optionalmailing_address?: {city?:string|null;country?:string|null;line1?:string|null;line2?:string|null;phone_number?:string|null;postal_code?:string|null;state?:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ city?: string | null; country?: string | null; line1?: string | null; line2?: string | null; phone_number?: string | null; postal_code?: string | null; state?: string | null; }
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
country?
Section titled “country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
line1?
Section titled “line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
line2?
Section titled “line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
phone_number?
Section titled “phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
postal_code?
Section titled “postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
state?
Section titled “state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
null
post.responses.200.content.application/json.metadata?
Section titled “post.responses.200.content.application/json.metadata?”
optionalmetadata?: {[key:string]:string; } |null
Description
Section titled “Description”Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters.
post.responses.200.content.application/json.owner
Section titled “post.responses.200.content.application/json.owner”owner:
object&object
Type Declaration
Section titled “Type Declaration”type:
"USER"
user_id
Section titled “user_id”user_id:
string
Type Declaration
Section titled “Type Declaration”type:
"USER"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
post.responses.200.content.application/json.spend_controls?
Section titled “post.responses.200.content.application/json.spend_controls?”
optionalspend_controls?: {allowed_merchant_details?:object[] |null;blocked_merchant_details?:object[] |null;lock_after_date?:string|null;reason?:string|null;spend_available?: {amount:number;currency: … | …; } |null;spend_duration?:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null;spend_limit?: {amount:number;currency: … | …; } |null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ allowed_merchant_details?: object[] | null; blocked_merchant_details?: object[] | null; lock_after_date?: string | null; reason?: string | null; spend_available?: { amount: number; currency: … | …; } | null; spend_duration?: "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME" | null; spend_limit?: { amount: number; currency: … | …; } | null; }
allowed_merchant_details?
Section titled “allowed_merchant_details?”
optionalallowed_merchant_details?:object[] |null
Description
Section titled “Description”List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured.
Example
Section titled “Example”[{"name": "Github"}, {"name": "AWS"}]blocked_merchant_details?
Section titled “blocked_merchant_details?”
optionalblocked_merchant_details?:object[] |null
Description
Section titled “Description”List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured.
Example
Section titled “Example”[{"name": "Apple"}, {"name": "Amazon"}]lock_after_date?
Section titled “lock_after_date?”
optionallock_after_date?:string|null
Format: date
Description
Section titled “Description”The lock_after_date is in UTC.
reason?
Section titled “reason?”
optionalreason?:string|null
spend_available?
Section titled “spend_available?”
optionalspend_available?: {amount:number;currency: … | …; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: … | …; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency: … | …
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
spend_duration?
Section titled “spend_duration?”
optionalspend_duration?:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null
spend_limit?
Section titled “spend_limit?”
optionalspend_limit?: {amount:number;currency: … | …; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: … | …; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency: … | …
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
null
post.responses.200.content.application/json.status?
Section titled “post.responses.200.content.application/json.status?”
optionalstatus?:"ACTIVE"|"TERMINATED"|"SHIPPED"|"LOCKED"|null
post.responses.200.headers
Section titled “post.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v2/cards/{id}/pan
Section titled “/v2/cards/{id}/pan”/v2/cards/{id}/pan:
object
Defined in: src/team/types.gen.ts:77
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
Get card number
Description
Section titled “Description”Retrieves card number, CVV, and expiration date of a card by ID.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path
Section titled “get.parameters.path”path:
object
get.parameters.path.id
Section titled “get.parameters.path.id”id:
string
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:undefined
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”getCardNumber 200 response
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.cvv
Section titled “get.responses.200.content.application/json.cvv”cvv:
string
get.responses.200.content.application/json.expiration_date
Section titled “get.responses.200.content.application/json.expiration_date”expiration_date:
object
get.responses.200.content.application/json.expiration_date.month
Section titled “get.responses.200.content.application/json.expiration_date.month”month:
number
Format: int32
get.responses.200.content.application/json.expiration_date.year
Section titled “get.responses.200.content.application/json.expiration_date.year”year:
number
Format: int32
get.responses.200.content.application/json.holder_name
Section titled “get.responses.200.content.application/json.holder_name”holder_name:
string
get.responses.200.content.application/json.id
Section titled “get.responses.200.content.application/json.id”id:
string
get.responses.200.content.application/json.number
Section titled “get.responses.200.content.application/json.number”number:
string
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v2/cards/{id}/secure_email
Section titled “/v2/cards/{id}/secure_email”/v2/cards/{id}/secure_email:
object
Defined in: src/team/types.gen.ts:97
delete?
Section titled “delete?”
optionaldelete?:undefined
optionalget?:undefined
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Create secure email to send card number
Description
Section titled “Description”Creates a secure email to send card number, CVV, and expiration date of a card by ID to the specified email.
This endpoint is currently gated. If you would like to request access, please reach out todeveloper-support@brex.compost.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header
Section titled “post.parameters.header”header:
object
post.parameters.header.Idempotency-Key
Section titled “post.parameters.header.Idempotency-Key”Idempotency-Key:
string
post.parameters.path
Section titled “post.parameters.path”path:
object
post.parameters.path.id
Section titled “post.parameters.path.id”id:
string
post.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody
Section titled “post.requestBody”requestBody:
object
post.requestBody.content
Section titled “post.requestBody.content”content:
object
post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”application/json:
object
post.requestBody.content.application/json.expiry_days?
Section titled “post.requestBody.content.application/json.expiry_days?”
optionalexpiry_days?:number|null
Format: int32
Description
Section titled “Description”Link expiry in number of days. Defaults to 30
post.requestBody.content.application/json.message?
Section titled “post.requestBody.content.application/json.message?”
optionalmessage?:string|null
Description
Section titled “Description”Message to send with the card details
post.requestBody.content.application/json.recipient_email
Section titled “post.requestBody.content.application/json.recipient_email”recipient_email:
string
Description
Section titled “Description”Email address to send card details to
post.requestBody.content.application/json.sender_name
Section titled “post.requestBody.content.application/json.sender_name”sender_name:
string
Description
Section titled “Description”Sender name. Shows up in the subject of the email
post.responses
Section titled “post.responses”responses:
object
post.responses.200
Section titled “post.responses.200”200:
object
Description
Section titled “Description”emailCardNumber 200 response
post.responses.200.content?
Section titled “post.responses.200.content?”
optionalcontent?:undefined
post.responses.200.headers
Section titled “post.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v2/cards/{id}/terminate
Section titled “/v2/cards/{id}/terminate”/v2/cards/{id}/terminate:
object
Defined in: src/team/types.gen.ts:120
delete?
Section titled “delete?”
optionaldelete?:undefined
optionalget?:undefined
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Terminate card
Description
Section titled “Description”Terminates an existing card. The card owner will receive a notification about it.
post.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header?
Section titled “post.parameters.header?”
optionalheader?:object
post.parameters.header.Idempotency-Key?
Section titled “post.parameters.header.Idempotency-Key?”
optionalIdempotency-Key?:string|null
post.parameters.path
Section titled “post.parameters.path”path:
object
post.parameters.path.id
Section titled “post.parameters.path.id”id:
string
post.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody
Section titled “post.requestBody”requestBody:
object
post.requestBody.content
Section titled “post.requestBody.content”content:
object
post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”application/json:
object
post.requestBody.content.application/json.description?
Section titled “post.requestBody.content.application/json.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description for terminating a card
post.requestBody.content.application/json.reason
Section titled “post.requestBody.content.application/json.reason”reason:
"OTHER"|"CARD_DAMAGED"|"CARD_LOST"|"CARD_NOT_RECEIVED"|"DO_NOT_NEED_PHYSICAL_CARD"|"DO_NOT_NEED_VIRTUAL_CARD"|"FRAUD"
post.responses
Section titled “post.responses”responses:
object
post.responses.200
Section titled “post.responses.200”200:
object
Description
Section titled “Description”terminateCard 200 response
post.responses.200.content
Section titled “post.responses.200.content”content:
object
post.responses.200.content.application/json
Section titled “post.responses.200.content.application/json”application/json:
object
post.responses.200.content.application/json.billing_address
Section titled “post.responses.200.content.application/json.billing_address”billing_address:
object
post.responses.200.content.application/json.billing_address.city?
Section titled “post.responses.200.content.application/json.billing_address.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
post.responses.200.content.application/json.billing_address.country?
Section titled “post.responses.200.content.application/json.billing_address.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
post.responses.200.content.application/json.billing_address.line1?
Section titled “post.responses.200.content.application/json.billing_address.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
post.responses.200.content.application/json.billing_address.line2?
Section titled “post.responses.200.content.application/json.billing_address.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
post.responses.200.content.application/json.billing_address.phone_number?
Section titled “post.responses.200.content.application/json.billing_address.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
post.responses.200.content.application/json.billing_address.postal_code?
Section titled “post.responses.200.content.application/json.billing_address.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
post.responses.200.content.application/json.billing_address.state?
Section titled “post.responses.200.content.application/json.billing_address.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
post.responses.200.content.application/json.budget_id?
Section titled “post.responses.200.content.application/json.budget_id?”
optionalbudget_id?:string|null
post.responses.200.content.application/json.card_name
Section titled “post.responses.200.content.application/json.card_name”card_name:
string
post.responses.200.content.application/json.card_type?
Section titled “post.responses.200.content.application/json.card_type?”
optionalcard_type?:"VIRTUAL"|"PHYSICAL"|null
post.responses.200.content.application/json.expiration_date
Section titled “post.responses.200.content.application/json.expiration_date”expiration_date:
object
post.responses.200.content.application/json.expiration_date.month
Section titled “post.responses.200.content.application/json.expiration_date.month”month:
number
Format: int32
post.responses.200.content.application/json.expiration_date.year
Section titled “post.responses.200.content.application/json.expiration_date.year”year:
number
Format: int32
post.responses.200.content.application/json.has_been_transferred?
Section titled “post.responses.200.content.application/json.has_been_transferred?”
optionalhas_been_transferred?:boolean
Description
Section titled “Description”Indicates whether a card has been transferred. Transferred cards have a spending restriction: we only allow transactions
at online vendors where this card was previously used before the transfer.
post.responses.200.content.application/json.id
Section titled “post.responses.200.content.application/json.id”id:
string
post.responses.200.content.application/json.last_four
Section titled “post.responses.200.content.application/json.last_four”last_four:
string
post.responses.200.content.application/json.limit_type
Section titled “post.responses.200.content.application/json.limit_type”limit_type:
"CARD"|"USER"
post.responses.200.content.application/json.mailing_address?
Section titled “post.responses.200.content.application/json.mailing_address?”
optionalmailing_address?: {city?:string|null;country?:string|null;line1?:string|null;line2?:string|null;phone_number?:string|null;postal_code?:string|null;state?:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ city?: string | null; country?: string | null; line1?: string | null; line2?: string | null; phone_number?: string | null; postal_code?: string | null; state?: string | null; }
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
country?
Section titled “country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
line1?
Section titled “line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
line2?
Section titled “line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
phone_number?
Section titled “phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
postal_code?
Section titled “postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
state?
Section titled “state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
null
post.responses.200.content.application/json.metadata?
Section titled “post.responses.200.content.application/json.metadata?”
optionalmetadata?: {[key:string]:string; } |null
Description
Section titled “Description”Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters.
post.responses.200.content.application/json.owner
Section titled “post.responses.200.content.application/json.owner”owner:
object&object
Type Declaration
Section titled “Type Declaration”type:
"USER"
user_id
Section titled “user_id”user_id:
string
Type Declaration
Section titled “Type Declaration”type:
"USER"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
post.responses.200.content.application/json.spend_controls?
Section titled “post.responses.200.content.application/json.spend_controls?”
optionalspend_controls?: {allowed_merchant_details?:object[] |null;blocked_merchant_details?:object[] |null;lock_after_date?:string|null;reason?:string|null;spend_available?: {amount:number;currency: … | …; } |null;spend_duration?:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null;spend_limit?: {amount:number;currency: … | …; } |null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ allowed_merchant_details?: object[] | null; blocked_merchant_details?: object[] | null; lock_after_date?: string | null; reason?: string | null; spend_available?: { amount: number; currency: … | …; } | null; spend_duration?: "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME" | null; spend_limit?: { amount: number; currency: … | …; } | null; }
allowed_merchant_details?
Section titled “allowed_merchant_details?”
optionalallowed_merchant_details?:object[] |null
Description
Section titled “Description”List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured.
Example
Section titled “Example”[{"name": "Github"}, {"name": "AWS"}]blocked_merchant_details?
Section titled “blocked_merchant_details?”
optionalblocked_merchant_details?:object[] |null
Description
Section titled “Description”List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured.
Example
Section titled “Example”[{"name": "Apple"}, {"name": "Amazon"}]lock_after_date?
Section titled “lock_after_date?”
optionallock_after_date?:string|null
Format: date
Description
Section titled “Description”The lock_after_date is in UTC.
reason?
Section titled “reason?”
optionalreason?:string|null
spend_available?
Section titled “spend_available?”
optionalspend_available?: {amount:number;currency: … | …; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: … | …; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency: … | …
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
spend_duration?
Section titled “spend_duration?”
optionalspend_duration?:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null
spend_limit?
Section titled “spend_limit?”
optionalspend_limit?: {amount:number;currency: … | …; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: … | …; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency: … | …
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
null
post.responses.200.content.application/json.status?
Section titled “post.responses.200.content.application/json.status?”
optionalstatus?:"ACTIVE"|"TERMINATED"|"SHIPPED"|"LOCKED"|null
post.responses.200.headers
Section titled “post.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v2/cards/{id}/unlock
Section titled “/v2/cards/{id}/unlock”/v2/cards/{id}/unlock:
object
Defined in: src/team/types.gen.ts:140
delete?
Section titled “delete?”
optionaldelete?:undefined
optionalget?:undefined
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Unlock card
Description
Section titled “Description”Unlocks an existing card.
post.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header?
Section titled “post.parameters.header?”
optionalheader?:object
post.parameters.header.Idempotency-Key?
Section titled “post.parameters.header.Idempotency-Key?”
optionalIdempotency-Key?:string|null
post.parameters.path
Section titled “post.parameters.path”path:
object
post.parameters.path.id
Section titled “post.parameters.path.id”id:
string
post.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody?
Section titled “post.requestBody?”
optionalrequestBody?:undefined
post.responses
Section titled “post.responses”responses:
object
post.responses.200
Section titled “post.responses.200”200:
object
Description
Section titled “Description”unlockCard 200 response
post.responses.200.content
Section titled “post.responses.200.content”content:
object
post.responses.200.content.application/json
Section titled “post.responses.200.content.application/json”application/json:
object
post.responses.200.content.application/json.billing_address
Section titled “post.responses.200.content.application/json.billing_address”billing_address:
object
post.responses.200.content.application/json.billing_address.city?
Section titled “post.responses.200.content.application/json.billing_address.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
post.responses.200.content.application/json.billing_address.country?
Section titled “post.responses.200.content.application/json.billing_address.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
post.responses.200.content.application/json.billing_address.line1?
Section titled “post.responses.200.content.application/json.billing_address.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
post.responses.200.content.application/json.billing_address.line2?
Section titled “post.responses.200.content.application/json.billing_address.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
post.responses.200.content.application/json.billing_address.phone_number?
Section titled “post.responses.200.content.application/json.billing_address.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
post.responses.200.content.application/json.billing_address.postal_code?
Section titled “post.responses.200.content.application/json.billing_address.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
post.responses.200.content.application/json.billing_address.state?
Section titled “post.responses.200.content.application/json.billing_address.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
post.responses.200.content.application/json.budget_id?
Section titled “post.responses.200.content.application/json.budget_id?”
optionalbudget_id?:string|null
post.responses.200.content.application/json.card_name
Section titled “post.responses.200.content.application/json.card_name”card_name:
string
post.responses.200.content.application/json.card_type?
Section titled “post.responses.200.content.application/json.card_type?”
optionalcard_type?:"VIRTUAL"|"PHYSICAL"|null
post.responses.200.content.application/json.expiration_date
Section titled “post.responses.200.content.application/json.expiration_date”expiration_date:
object
post.responses.200.content.application/json.expiration_date.month
Section titled “post.responses.200.content.application/json.expiration_date.month”month:
number
Format: int32
post.responses.200.content.application/json.expiration_date.year
Section titled “post.responses.200.content.application/json.expiration_date.year”year:
number
Format: int32
post.responses.200.content.application/json.has_been_transferred?
Section titled “post.responses.200.content.application/json.has_been_transferred?”
optionalhas_been_transferred?:boolean
Description
Section titled “Description”Indicates whether a card has been transferred. Transferred cards have a spending restriction: we only allow transactions
at online vendors where this card was previously used before the transfer.
post.responses.200.content.application/json.id
Section titled “post.responses.200.content.application/json.id”id:
string
post.responses.200.content.application/json.last_four
Section titled “post.responses.200.content.application/json.last_four”last_four:
string
post.responses.200.content.application/json.limit_type
Section titled “post.responses.200.content.application/json.limit_type”limit_type:
"CARD"|"USER"
post.responses.200.content.application/json.mailing_address?
Section titled “post.responses.200.content.application/json.mailing_address?”
optionalmailing_address?: {city?:string|null;country?:string|null;line1?:string|null;line2?:string|null;phone_number?:string|null;postal_code?:string|null;state?:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ city?: string | null; country?: string | null; line1?: string | null; line2?: string | null; phone_number?: string | null; postal_code?: string | null; state?: string | null; }
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
country?
Section titled “country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
line1?
Section titled “line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
line2?
Section titled “line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
phone_number?
Section titled “phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
postal_code?
Section titled “postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
state?
Section titled “state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
null
post.responses.200.content.application/json.metadata?
Section titled “post.responses.200.content.application/json.metadata?”
optionalmetadata?: {[key:string]:string; } |null
Description
Section titled “Description”Set of key value pairs associated with this object. Please do not store any personally identifiable or sensitive information here. Limitations: maximum of 50 keys, keys cannot exceed 40 characters, values cannot exceed 500 characters.
post.responses.200.content.application/json.owner
Section titled “post.responses.200.content.application/json.owner”owner:
object&object
Type Declaration
Section titled “Type Declaration”type:
"USER"
user_id
Section titled “user_id”user_id:
string
Type Declaration
Section titled “Type Declaration”type:
"USER"
Description
Section titled “Description”discriminator enum property added by openapi-typescript
post.responses.200.content.application/json.spend_controls?
Section titled “post.responses.200.content.application/json.spend_controls?”
optionalspend_controls?: {allowed_merchant_details?:object[] |null;blocked_merchant_details?:object[] |null;lock_after_date?:string|null;reason?:string|null;spend_available?: {amount:number;currency: … | …; } |null;spend_duration?:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null;spend_limit?: {amount:number;currency: … | …; } |null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ allowed_merchant_details?: object[] | null; blocked_merchant_details?: object[] | null; lock_after_date?: string | null; reason?: string | null; spend_available?: { amount: number; currency: … | …; } | null; spend_duration?: "MONTHLY" | "QUARTERLY" | "YEARLY" | "ONE_TIME" | null; spend_limit?: { amount: number; currency: … | …; } | null; }
allowed_merchant_details?
Section titled “allowed_merchant_details?”
optionalallowed_merchant_details?:object[] |null
Description
Section titled “Description”List of merchant details where card transactions are allowed. Empty if no allowed merchant details are configured.
Example
Section titled “Example”[{"name": "Github"}, {"name": "AWS"}]blocked_merchant_details?
Section titled “blocked_merchant_details?”
optionalblocked_merchant_details?:object[] |null
Description
Section titled “Description”List of merchant details where card transactions are blocked. Empty if no blocked merchant details are configured.
Example
Section titled “Example”[{"name": "Apple"}, {"name": "Amazon"}]lock_after_date?
Section titled “lock_after_date?”
optionallock_after_date?:string|null
Format: date
Description
Section titled “Description”The lock_after_date is in UTC.
reason?
Section titled “reason?”
optionalreason?:string|null
spend_available?
Section titled “spend_available?”
optionalspend_available?: {amount:number;currency: … | …; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: … | …; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency: … | …
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
spend_duration?
Section titled “spend_duration?”
optionalspend_duration?:"MONTHLY"|"QUARTERLY"|"YEARLY"|"ONE_TIME"|null
spend_limit?
Section titled “spend_limit?”
optionalspend_limit?: {amount:number;currency: … | …; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: … | …; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency: … | …
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
null
post.responses.200.content.application/json.status?
Section titled “post.responses.200.content.application/json.status?”
optionalstatus?:"ACTIVE"|"TERMINATED"|"SHIPPED"|"LOCKED"|null
post.responses.200.headers
Section titled “post.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v2/company
Section titled “/v2/company”/v2/company:
object
Defined in: src/team/types.gen.ts:160
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
Get company
Description
Section titled “Description”This endpoint returns the company associated with the OAuth2 access token.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path?
Section titled “get.parameters.path?”
optionalpath?:undefined
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:undefined
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”getCompany 200 response
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.accountType
Section titled “get.responses.200.content.application/json.accountType”accountType:
"BREX_CLASSIC"|"BREX_EMPOWER"
get.responses.200.content.application/json.id
Section titled “get.responses.200.content.application/json.id”id:
string
get.responses.200.content.application/json.legal_name
Section titled “get.responses.200.content.application/json.legal_name”legal_name:
string
get.responses.200.content.application/json.mailing_address
Section titled “get.responses.200.content.application/json.mailing_address”mailing_address:
object
get.responses.200.content.application/json.mailing_address.city?
Section titled “get.responses.200.content.application/json.mailing_address.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
get.responses.200.content.application/json.mailing_address.country?
Section titled “get.responses.200.content.application/json.mailing_address.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
get.responses.200.content.application/json.mailing_address.line1?
Section titled “get.responses.200.content.application/json.mailing_address.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
get.responses.200.content.application/json.mailing_address.line2?
Section titled “get.responses.200.content.application/json.mailing_address.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
get.responses.200.content.application/json.mailing_address.phone_number?
Section titled “get.responses.200.content.application/json.mailing_address.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
get.responses.200.content.application/json.mailing_address.postal_code?
Section titled “get.responses.200.content.application/json.mailing_address.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
get.responses.200.content.application/json.mailing_address.state?
Section titled “get.responses.200.content.application/json.mailing_address.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v2/departments
Section titled “/v2/departments”/v2/departments:
object
Defined in: src/team/types.gen.ts:180
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
List departments
Description
Section titled “Description”This endpoint lists all departments.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path?
Section titled “get.parameters.path?”
optionalpath?:undefined
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:object
get.parameters.query.cursor?
Section titled “get.parameters.query.cursor?”
optionalcursor?:string|null
get.parameters.query.limit?
Section titled “get.parameters.query.limit?”
optionallimit?:number|null
get.parameters.query.name?
Section titled “get.parameters.query.name?”
optionalname?:string|null
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”listDepartments 200 response
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.items
Section titled “get.responses.200.content.application/json.items”items:
object[]
get.responses.200.content.application/json.next_cursor?
Section titled “get.responses.200.content.application/json.next_cursor?”
optionalnext_cursor?:string|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Create department
Description
Section titled “Description”This endpoint creates a new department
post.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header?
Section titled “post.parameters.header?”
optionalheader?:object
post.parameters.header.Idempotency-Key?
Section titled “post.parameters.header.Idempotency-Key?”
optionalIdempotency-Key?:string|null
post.parameters.path?
Section titled “post.parameters.path?”
optionalpath?:undefined
post.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody
Section titled “post.requestBody”requestBody:
object
post.requestBody.content
Section titled “post.requestBody.content”content:
object
post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”application/json:
object
post.requestBody.content.application/json.description?
Section titled “post.requestBody.content.application/json.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of the department
post.requestBody.content.application/json.name
Section titled “post.requestBody.content.application/json.name”name:
string
Description
Section titled “Description”Name of the department
post.responses
Section titled “post.responses”responses:
object
post.responses.200
Section titled “post.responses.200”200:
object
Description
Section titled “Description”createDepartment 200 response
post.responses.200.content
Section titled “post.responses.200.content”content:
object
post.responses.200.content.application/json
Section titled “post.responses.200.content.application/json”application/json:
object
post.responses.200.content.application/json.description?
Section titled “post.responses.200.content.application/json.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of the department
post.responses.200.content.application/json.id
Section titled “post.responses.200.content.application/json.id”id:
string
post.responses.200.content.application/json.name
Section titled “post.responses.200.content.application/json.name”name:
string
Description
Section titled “Description”Name of the department
post.responses.200.headers
Section titled “post.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v2/departments/{id}
Section titled “/v2/departments/{id}”/v2/departments/{id}:
object
Defined in: src/team/types.gen.ts:204
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
Get department
Description
Section titled “Description”This endpoint gets a department by ID.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path
Section titled “get.parameters.path”path:
object
get.parameters.path.id
Section titled “get.parameters.path.id”id:
string
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:undefined
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”getDepartmentById 200 response
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.description?
Section titled “get.responses.200.content.application/json.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of the department
get.responses.200.content.application/json.id
Section titled “get.responses.200.content.application/json.id”id:
string
get.responses.200.content.application/json.name
Section titled “get.responses.200.content.application/json.name”name:
string
Description
Section titled “Description”Name of the department
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v2/legal_entities
Section titled “/v2/legal_entities”/v2/legal_entities:
object
Defined in: src/team/types.gen.ts:224
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
List legal entities
Description
Section titled “Description”List legal entities for the account.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path?
Section titled “get.parameters.path?”
optionalpath?:undefined
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:object
get.parameters.query.cursor?
Section titled “get.parameters.query.cursor?”
optionalcursor?:string|null
get.parameters.query.limit?
Section titled “get.parameters.query.limit?”
optionallimit?:number|null
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”listLegalEntities 200 response
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.items
Section titled “get.responses.200.content.application/json.items”items:
object[]
get.responses.200.content.application/json.next_cursor?
Section titled “get.responses.200.content.application/json.next_cursor?”
optionalnext_cursor?:string|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v2/legal_entities/{id}
Section titled “/v2/legal_entities/{id}”/v2/legal_entities/{id}:
object
Defined in: src/team/types.gen.ts:244
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
Get legal entity
Description
Section titled “Description”Get a legal entity by its ID.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path
Section titled “get.parameters.path”path:
object
get.parameters.path.id
Section titled “get.parameters.path.id”id:
string
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:undefined
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”getLegalEntity 200 response
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.billingAddress
Section titled “get.responses.200.content.application/json.billingAddress”billingAddress:
object
get.responses.200.content.application/json.billingAddress.city?
Section titled “get.responses.200.content.application/json.billingAddress.city?”
optionalcity?:string|null
Description
Section titled “Description”City, district, suburb, town, or village.
get.responses.200.content.application/json.billingAddress.country?
Section titled “get.responses.200.content.application/json.billingAddress.country?”
optionalcountry?:string|null
Description
Section titled “Description”Two-letter country code (ISO 3166-1 alpha-2).
get.responses.200.content.application/json.billingAddress.line1?
Section titled “get.responses.200.content.application/json.billingAddress.line1?”
optionalline1?:string|null
Description
Section titled “Description”Address line 1, no PO Box.
get.responses.200.content.application/json.billingAddress.line2?
Section titled “get.responses.200.content.application/json.billingAddress.line2?”
optionalline2?:string|null
Description
Section titled “Description”Address line 2 (e.g., apartment, suite, unit, or building).
get.responses.200.content.application/json.billingAddress.phone_number?
Section titled “get.responses.200.content.application/json.billingAddress.phone_number?”
optionalphone_number?:string|null
Description
Section titled “Description”Phone number.
get.responses.200.content.application/json.billingAddress.postal_code?
Section titled “get.responses.200.content.application/json.billingAddress.postal_code?”
optionalpostal_code?:string|null
Description
Section titled “Description”ZIP or postal code.
get.responses.200.content.application/json.billingAddress.state?
Section titled “get.responses.200.content.application/json.billingAddress.state?”
optionalstate?:string|null
Description
Section titled “Description”For US-addressed the 2-letter State abbreviation. For international-addresses the county, providence, or region.
get.responses.200.content.application/json.createdAt
Section titled “get.responses.200.content.application/json.createdAt”createdAt:
string
Format: date-time
Description
Section titled “Description”Timestamp, in UTC, when this legal entity was created.
get.responses.200.content.application/json.displayName
Section titled “get.responses.200.content.application/json.displayName”displayName:
string
Description
Section titled “Description”The display name of this legal entity.
get.responses.200.content.application/json.id
Section titled “get.responses.200.content.application/json.id”id:
string
Description
Section titled “Description”The ID of this legal entity.
get.responses.200.content.application/json.isDefault?
Section titled “get.responses.200.content.application/json.isDefault?”
optionalisDefault?:boolean
Description
Section titled “Description”Whether this is the default entity of the account.
get.responses.200.content.application/json.status
Section titled “get.responses.200.content.application/json.status”status:
"UNSUBMITTED"|"UNVERIFIED"|"IN_PROGRESS"|"VERIFIED"|"REJECTED"
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v2/locations
Section titled “/v2/locations”/v2/locations:
object
Defined in: src/team/types.gen.ts:264
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
List locations
Description
Section titled “Description”This endpoint lists all locations.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path?
Section titled “get.parameters.path?”
optionalpath?:undefined
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:object
get.parameters.query.cursor?
Section titled “get.parameters.query.cursor?”
optionalcursor?:string|null
get.parameters.query.limit?
Section titled “get.parameters.query.limit?”
optionallimit?:number|null
get.parameters.query.name?
Section titled “get.parameters.query.name?”
optionalname?:string|null
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”listLocations 200 response
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.items
Section titled “get.responses.200.content.application/json.items”items:
object[]
get.responses.200.content.application/json.next_cursor?
Section titled “get.responses.200.content.application/json.next_cursor?”
optionalnext_cursor?:string|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Create location
Description
Section titled “Description”This endpoint creates a new location.
post.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header?
Section titled “post.parameters.header?”
optionalheader?:object
post.parameters.header.Idempotency-Key?
Section titled “post.parameters.header.Idempotency-Key?”
optionalIdempotency-Key?:string|null
post.parameters.path?
Section titled “post.parameters.path?”
optionalpath?:undefined
post.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody
Section titled “post.requestBody”requestBody:
object
post.requestBody.content
Section titled “post.requestBody.content”content:
object
post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”application/json:
object
post.requestBody.content.application/json.description?
Section titled “post.requestBody.content.application/json.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of the location
post.requestBody.content.application/json.name
Section titled “post.requestBody.content.application/json.name”name:
string
Description
Section titled “Description”Name of the location
post.responses
Section titled “post.responses”responses:
object
post.responses.200
Section titled “post.responses.200”200:
object
Description
Section titled “Description”createLocation 200 response
post.responses.200.content
Section titled “post.responses.200.content”content:
object
post.responses.200.content.application/json
Section titled “post.responses.200.content.application/json”application/json:
object
post.responses.200.content.application/json.description?
Section titled “post.responses.200.content.application/json.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of the location
post.responses.200.content.application/json.id
Section titled “post.responses.200.content.application/json.id”id:
string
post.responses.200.content.application/json.name
Section titled “post.responses.200.content.application/json.name”name:
string
Description
Section titled “Description”Name of the location
post.responses.200.headers
Section titled “post.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v2/locations/{id}
Section titled “/v2/locations/{id}”/v2/locations/{id}:
object
Defined in: src/team/types.gen.ts:288
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
Get location
Description
Section titled “Description”This endpoint gets a location by ID.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path
Section titled “get.parameters.path”path:
object
get.parameters.path.id
Section titled “get.parameters.path.id”id:
string
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:undefined
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”getLocationById 200 response
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.description?
Section titled “get.responses.200.content.application/json.description?”
optionaldescription?:string|null
Description
Section titled “Description”Description of the location
get.responses.200.content.application/json.id
Section titled “get.responses.200.content.application/json.id”id:
string
get.responses.200.content.application/json.name
Section titled “get.responses.200.content.application/json.name”name:
string
Description
Section titled “Description”Name of the location
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v2/titles
Section titled “/v2/titles”/v2/titles:
object
Defined in: src/team/types.gen.ts:308
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
List titles
Description
Section titled “Description”This endpoint lists all titles.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path?
Section titled “get.parameters.path?”
optionalpath?:undefined
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:object
get.parameters.query.cursor?
Section titled “get.parameters.query.cursor?”
optionalcursor?:string|null
get.parameters.query.limit?
Section titled “get.parameters.query.limit?”
optionallimit?:number|null
get.parameters.query.name?
Section titled “get.parameters.query.name?”
optionalname?:string|null
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”listTitles 200 response
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.items
Section titled “get.responses.200.content.application/json.items”items:
object[]
get.responses.200.content.application/json.next_cursor?
Section titled “get.responses.200.content.application/json.next_cursor?”
optionalnext_cursor?:string|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Create title
Description
Section titled “Description”This endpoint creates a new title
post.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header?
Section titled “post.parameters.header?”
optionalheader?:object
post.parameters.header.Idempotency-Key?
Section titled “post.parameters.header.Idempotency-Key?”
optionalIdempotency-Key?:string|null
post.parameters.path?
Section titled “post.parameters.path?”
optionalpath?:undefined
post.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody
Section titled “post.requestBody”requestBody:
object
post.requestBody.content
Section titled “post.requestBody.content”content:
object
post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”application/json:
object
post.requestBody.content.application/json.name
Section titled “post.requestBody.content.application/json.name”name:
string
Description
Section titled “Description”Name of the title
post.responses
Section titled “post.responses”responses:
object
post.responses.200
Section titled “post.responses.200”200:
object
Description
Section titled “Description”createTitle 200 response
post.responses.200.content
Section titled “post.responses.200.content”content:
object
post.responses.200.content.application/json
Section titled “post.responses.200.content.application/json”application/json:
object
post.responses.200.content.application/json.id
Section titled “post.responses.200.content.application/json.id”id:
string
post.responses.200.content.application/json.name
Section titled “post.responses.200.content.application/json.name”name:
string
Description
Section titled “Description”Name of the title
post.responses.200.headers
Section titled “post.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v2/titles/{id}
Section titled “/v2/titles/{id}”/v2/titles/{id}:
object
Defined in: src/team/types.gen.ts:332
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
Get title
Description
Section titled “Description”This endpoint gets a title by ID.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path
Section titled “get.parameters.path”path:
object
get.parameters.path.id
Section titled “get.parameters.path.id”id:
string
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:undefined
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”getTitleById 200 response
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.id
Section titled “get.responses.200.content.application/json.id”id:
string
get.responses.200.content.application/json.name
Section titled “get.responses.200.content.application/json.name”name:
string
Description
Section titled “Description”Name of the title
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v2/users
Section titled “/v2/users”/v2/users:
object
Defined in: src/team/types.gen.ts:352
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
List users
Description
Section titled “Description”This endpoint lists all users. To find a user id by email, you can filter using the email query parameter.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path?
Section titled “get.parameters.path?”
optionalpath?:undefined
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:object
get.parameters.query.cursor?
Section titled “get.parameters.query.cursor?”
optionalcursor?:string|null
get.parameters.query.email?
Section titled “get.parameters.query.email?”
optionalemail?:string|null
get.parameters.query.expand[]?
Section titled “get.parameters.query.expand[]?”
optionalexpand[]?:string[] |null
get.parameters.query.limit?
Section titled “get.parameters.query.limit?”
optionallimit?:number|null
get.parameters.query.remote_display_id?
Section titled “get.parameters.query.remote_display_id?”
optionalremote_display_id?:string|null
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”listUsers 200 response
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.items
Section titled “get.responses.200.content.application/json.items”items:
object[]
get.responses.200.content.application/json.next_cursor?
Section titled “get.responses.200.content.application/json.next_cursor?”
optionalnext_cursor?:string|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Invite user
Description
Section titled “Description”This endpoint invites a new user as an employee. To update user’s role, check out this article.
post.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header?
Section titled “post.parameters.header?”
optionalheader?:object
post.parameters.header.Idempotency-Key?
Section titled “post.parameters.header.Idempotency-Key?”
optionalIdempotency-Key?:string|null
post.parameters.path?
Section titled “post.parameters.path?”
optionalpath?:undefined
post.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody
Section titled “post.requestBody”requestBody:
object
post.requestBody.content
Section titled “post.requestBody.content”content:
object
post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”application/json:
object
post.requestBody.content.application/json.department_id?
Section titled “post.requestBody.content.application/json.department_id?”
optionaldepartment_id?:string|null
post.requestBody.content.application/json.email
Section titled “post.requestBody.content.application/json.email”email:
string
Format: email
post.requestBody.content.application/json.first_name
Section titled “post.requestBody.content.application/json.first_name”first_name:
string
post.requestBody.content.application/json.last_name
Section titled “post.requestBody.content.application/json.last_name”last_name:
string
post.requestBody.content.application/json.location_id?
Section titled “post.requestBody.content.application/json.location_id?”
optionallocation_id?:string|null
post.requestBody.content.application/json.manager_id?
Section titled “post.requestBody.content.application/json.manager_id?”
optionalmanager_id?:string|null
post.requestBody.content.application/json.metadata?
Section titled “post.requestBody.content.application/json.metadata?”
optionalmetadata?: {[key:string]:string; } |null
Description
Section titled “Description”The metadata or customized attributes of the user. Maximum number of entries: 100
post.requestBody.content.application/json.title_id?
Section titled “post.requestBody.content.application/json.title_id?”
optionaltitle_id?:string|null
post.responses
Section titled “post.responses”responses:
object
post.responses.200
Section titled “post.responses.200”200:
object
Description
Section titled “Description”createUser 200 response
post.responses.200.content
Section titled “post.responses.200.content”content:
object
post.responses.200.content.application/json
Section titled “post.responses.200.content.application/json”application/json:
object
post.responses.200.content.application/json.department_id?
Section titled “post.responses.200.content.application/json.department_id?”
optionaldepartment_id?:string|null
post.responses.200.content.application/json.email
Section titled “post.responses.200.content.application/json.email”email:
string
Description
Section titled “Description”Email address of the user
post.responses.200.content.application/json.first_name
Section titled “post.responses.200.content.application/json.first_name”first_name:
string
Description
Section titled “Description”First name of the user
post.responses.200.content.application/json.id
Section titled “post.responses.200.content.application/json.id”id:
string
post.responses.200.content.application/json.last_name
Section titled “post.responses.200.content.application/json.last_name”last_name:
string
Description
Section titled “Description”Last name of the user
post.responses.200.content.application/json.location_id?
Section titled “post.responses.200.content.application/json.location_id?”
optionallocation_id?:string|null
post.responses.200.content.application/json.manager_id?
Section titled “post.responses.200.content.application/json.manager_id?”
optionalmanager_id?:string|null
Description
Section titled “Description”The user id of the manager of this user
post.responses.200.content.application/json.metadata?
Section titled “post.responses.200.content.application/json.metadata?”
optionalmetadata?: {[key:string]:string; } |null
Description
Section titled “Description”The metadata or customized attributes of the user. Maximum number of entries: 100
post.responses.200.content.application/json.remote_display_id?
Section titled “post.responses.200.content.application/json.remote_display_id?”
optionalremote_display_id?:string|null
Description
Section titled “Description”Identifier that is displayed on the IDP or HR system, eg, if OKTA identifies you as user xyz
post.responses.200.content.application/json.status?
Section titled “post.responses.200.content.application/json.status?”
optionalstatus?:"ACTIVE"|"DISABLED"|"ARCHIVED"|"DELETED"|"INACTIVE"|"INVITED"|"PENDING_ACTIVATION"|"CLOSED"|null
post.responses.200.content.application/json.title_id?
Section titled “post.responses.200.content.application/json.title_id?”
optionaltitle_id?:string|null
post.responses.200.headers
Section titled “post.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v2/users/{id}
Section titled “/v2/users/{id}”/v2/users/{id}:
object
Defined in: src/team/types.gen.ts:377
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
Get user
Description
Section titled “Description”This endpoint gets a user by ID.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path
Section titled “get.parameters.path”path:
object
get.parameters.path.id
Section titled “get.parameters.path.id”id:
string
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:undefined
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”getUserById 200 response
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.department_id?
Section titled “get.responses.200.content.application/json.department_id?”
optionaldepartment_id?:string|null
get.responses.200.content.application/json.email
Section titled “get.responses.200.content.application/json.email”email:
string
Description
Section titled “Description”Email address of the user
get.responses.200.content.application/json.first_name
Section titled “get.responses.200.content.application/json.first_name”first_name:
string
Description
Section titled “Description”First name of the user
get.responses.200.content.application/json.id
Section titled “get.responses.200.content.application/json.id”id:
string
get.responses.200.content.application/json.last_name
Section titled “get.responses.200.content.application/json.last_name”last_name:
string
Description
Section titled “Description”Last name of the user
get.responses.200.content.application/json.location_id?
Section titled “get.responses.200.content.application/json.location_id?”
optionallocation_id?:string|null
get.responses.200.content.application/json.manager_id?
Section titled “get.responses.200.content.application/json.manager_id?”
optionalmanager_id?:string|null
Description
Section titled “Description”The user id of the manager of this user
get.responses.200.content.application/json.metadata?
Section titled “get.responses.200.content.application/json.metadata?”
optionalmetadata?: {[key:string]:string; } |null
Description
Section titled “Description”The metadata or customized attributes of the user. Maximum number of entries: 100
get.responses.200.content.application/json.remote_display_id?
Section titled “get.responses.200.content.application/json.remote_display_id?”
optionalremote_display_id?:string|null
Description
Section titled “Description”Identifier that is displayed on the IDP or HR system, eg, if OKTA identifies you as user xyz
get.responses.200.content.application/json.status?
Section titled “get.responses.200.content.application/json.status?”
optionalstatus?:"ACTIVE"|"DISABLED"|"ARCHIVED"|"DELETED"|"INACTIVE"|"INVITED"|"PENDING_ACTIVATION"|"CLOSED"|null
get.responses.200.content.application/json.title_id?
Section titled “get.responses.200.content.application/json.title_id?”
optionaltitle_id?:string|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
put:
object
Update user
Description
Section titled “Description”This endpoint updates a user. Any parameters not provided will be left unchanged.
put.parameters
Section titled “put.parameters”parameters:
object
put.parameters.cookie?
Section titled “put.parameters.cookie?”
optionalcookie?:undefined
put.parameters.header?
Section titled “put.parameters.header?”
optionalheader?:object
put.parameters.header.Idempotency-Key?
Section titled “put.parameters.header.Idempotency-Key?”
optionalIdempotency-Key?:string|null
put.parameters.path
Section titled “put.parameters.path”path:
object
put.parameters.path.id
Section titled “put.parameters.path.id”id:
string
put.parameters.query?
Section titled “put.parameters.query?”
optionalquery?:undefined
put.requestBody
Section titled “put.requestBody”requestBody:
object
put.requestBody.content
Section titled “put.requestBody.content”content:
object
put.requestBody.content.application/json
Section titled “put.requestBody.content.application/json”application/json:
object
put.requestBody.content.application/json.department_id?
Section titled “put.requestBody.content.application/json.department_id?”
optionaldepartment_id?:string|null
put.requestBody.content.application/json.location_id?
Section titled “put.requestBody.content.application/json.location_id?”
optionallocation_id?:string|null
put.requestBody.content.application/json.manager_id?
Section titled “put.requestBody.content.application/json.manager_id?”
optionalmanager_id?:string|null
Description
Section titled “Description”The user id of the manager of this user
put.requestBody.content.application/json.metadata?
Section titled “put.requestBody.content.application/json.metadata?”
optionalmetadata?: {[key:string]:string; } |null
Description
Section titled “Description”The metadata or customized attributes of the user. Maximum number of entries: 100
put.requestBody.content.application/json.status?
Section titled “put.requestBody.content.application/json.status?”
optionalstatus?:"ACTIVE"|"DISABLED"|null
put.requestBody.content.application/json.title_id?
Section titled “put.requestBody.content.application/json.title_id?”
optionaltitle_id?:string|null
put.responses
Section titled “put.responses”responses:
object
put.responses.200
Section titled “put.responses.200”200:
object
Description
Section titled “Description”updateUser 200 response
put.responses.200.content
Section titled “put.responses.200.content”content:
object
put.responses.200.content.application/json
Section titled “put.responses.200.content.application/json”application/json:
object
put.responses.200.content.application/json.department_id?
Section titled “put.responses.200.content.application/json.department_id?”
optionaldepartment_id?:string|null
put.responses.200.content.application/json.email
Section titled “put.responses.200.content.application/json.email”email:
string
Description
Section titled “Description”Email address of the user
put.responses.200.content.application/json.first_name
Section titled “put.responses.200.content.application/json.first_name”first_name:
string
Description
Section titled “Description”First name of the user
put.responses.200.content.application/json.id
Section titled “put.responses.200.content.application/json.id”id:
string
put.responses.200.content.application/json.last_name
Section titled “put.responses.200.content.application/json.last_name”last_name:
string
Description
Section titled “Description”Last name of the user
put.responses.200.content.application/json.location_id?
Section titled “put.responses.200.content.application/json.location_id?”
optionallocation_id?:string|null
put.responses.200.content.application/json.manager_id?
Section titled “put.responses.200.content.application/json.manager_id?”
optionalmanager_id?:string|null
Description
Section titled “Description”The user id of the manager of this user
put.responses.200.content.application/json.metadata?
Section titled “put.responses.200.content.application/json.metadata?”
optionalmetadata?: {[key:string]:string; } |null
Description
Section titled “Description”The metadata or customized attributes of the user. Maximum number of entries: 100
put.responses.200.content.application/json.remote_display_id?
Section titled “put.responses.200.content.application/json.remote_display_id?”
optionalremote_display_id?:string|null
Description
Section titled “Description”Identifier that is displayed on the IDP or HR system, eg, if OKTA identifies you as user xyz
put.responses.200.content.application/json.status?
Section titled “put.responses.200.content.application/json.status?”
optionalstatus?:"ACTIVE"|"DISABLED"|"ARCHIVED"|"DELETED"|"INACTIVE"|"INVITED"|"PENDING_ACTIVATION"|"CLOSED"|null
put.responses.200.content.application/json.title_id?
Section titled “put.responses.200.content.application/json.title_id?”
optionaltitle_id?:string|null
put.responses.200.headers
Section titled “put.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
trace?
Section titled “trace?”
optionaltrace?:undefined
/v2/users/{id}/limit
Section titled “/v2/users/{id}/limit”/v2/users/{id}/limit:
object
Defined in: src/team/types.gen.ts:401
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
Get limit for the user
Description
Section titled “Description”This endpoint gets the monthly limit for the user including the monthly available limit.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path
Section titled “get.parameters.path”path:
object
get.parameters.path.id
Section titled “get.parameters.path.id”id:
string
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:undefined
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”getUserLimit 200 response
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.monthly_available?
Section titled “get.responses.200.content.application/json.monthly_available?”
optionalmonthly_available?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
get.responses.200.content.application/json.monthly_limit?
Section titled “get.responses.200.content.application/json.monthly_limit?”
optionalmonthly_limit?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
post:
object
Set limit for the user
Description
Section titled “Description”This endpoint sets the monthly limit for a user.
The limit amount must be non-negative.
To unset the monthly limit of the user, just set monthly_limit to null.
post.parameters
Section titled “post.parameters”parameters:
object
post.parameters.cookie?
Section titled “post.parameters.cookie?”
optionalcookie?:undefined
post.parameters.header?
Section titled “post.parameters.header?”
optionalheader?:object
post.parameters.header.Idempotency-Key?
Section titled “post.parameters.header.Idempotency-Key?”
optionalIdempotency-Key?:string|null
post.parameters.path
Section titled “post.parameters.path”path:
object
post.parameters.path.id
Section titled “post.parameters.path.id”id:
string
post.parameters.query?
Section titled “post.parameters.query?”
optionalquery?:undefined
post.requestBody
Section titled “post.requestBody”requestBody:
object
post.requestBody.content
Section titled “post.requestBody.content”content:
object
post.requestBody.content.application/json
Section titled “post.requestBody.content.application/json”application/json:
object
post.requestBody.content.application/json.monthly_limit?
Section titled “post.requestBody.content.application/json.monthly_limit?”
optionalmonthly_limit?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
post.responses
Section titled “post.responses”responses:
object
post.responses.200
Section titled “post.responses.200”200:
object
Description
Section titled “Description”setUserLimit 200 response
post.responses.200.content
Section titled “post.responses.200.content”content:
object
post.responses.200.content.application/json
Section titled “post.responses.200.content.application/json”application/json:
object
post.responses.200.content.application/json.monthly_available?
Section titled “post.responses.200.content.application/json.monthly_available?”
optionalmonthly_available?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
post.responses.200.content.application/json.monthly_limit?
Section titled “post.responses.200.content.application/json.monthly_limit?”
optionalmonthly_limit?: {amount:number;currency:string|null; } |null
Union Members
Section titled “Union Members”Type Literal
Section titled “Type Literal”{ amount: number; currency: string | null; }
amount
Section titled “amount”amount:
number
Format: int64
Description
Section titled “Description”The amount of money, in the smallest denomination of the currency indicated by currency. For example, when currency is USD, amount is in cents.
Example
Section titled “Example”700currency
Section titled “currency”currency:
string|null
Description
Section titled “Description”The type of currency, in ISO 4217 format.
Default
Section titled “Default”USDExample
Section titled “Example”USDnull
post.responses.200.headers
Section titled “post.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined
/v2/users/me
Section titled “/v2/users/me”/v2/users/me:
object
Defined in: src/team/types.gen.ts:427
delete?
Section titled “delete?”
optionaldelete?:undefined
get:
object
Get current user
Description
Section titled “Description”This endpoint returns the user associated with the OAuth2 access token.
get.parameters
Section titled “get.parameters”parameters:
object
get.parameters.cookie?
Section titled “get.parameters.cookie?”
optionalcookie?:undefined
get.parameters.header?
Section titled “get.parameters.header?”
optionalheader?:undefined
get.parameters.path?
Section titled “get.parameters.path?”
optionalpath?:undefined
get.parameters.query?
Section titled “get.parameters.query?”
optionalquery?:undefined
get.requestBody?
Section titled “get.requestBody?”
optionalrequestBody?:undefined
get.responses
Section titled “get.responses”responses:
object
get.responses.200
Section titled “get.responses.200”200:
object
Description
Section titled “Description”getMe 200 response
get.responses.200.content
Section titled “get.responses.200.content”content:
object
get.responses.200.content.application/json
Section titled “get.responses.200.content.application/json”application/json:
object
get.responses.200.content.application/json.department_id?
Section titled “get.responses.200.content.application/json.department_id?”
optionaldepartment_id?:string|null
get.responses.200.content.application/json.email
Section titled “get.responses.200.content.application/json.email”email:
string
Description
Section titled “Description”Email address of the user
get.responses.200.content.application/json.first_name
Section titled “get.responses.200.content.application/json.first_name”first_name:
string
Description
Section titled “Description”First name of the user
get.responses.200.content.application/json.id
Section titled “get.responses.200.content.application/json.id”id:
string
get.responses.200.content.application/json.last_name
Section titled “get.responses.200.content.application/json.last_name”last_name:
string
Description
Section titled “Description”Last name of the user
get.responses.200.content.application/json.location_id?
Section titled “get.responses.200.content.application/json.location_id?”
optionallocation_id?:string|null
get.responses.200.content.application/json.manager_id?
Section titled “get.responses.200.content.application/json.manager_id?”
optionalmanager_id?:string|null
Description
Section titled “Description”The user id of the manager of this user
get.responses.200.content.application/json.metadata?
Section titled “get.responses.200.content.application/json.metadata?”
optionalmetadata?: {[key:string]:string; } |null
Description
Section titled “Description”The metadata or customized attributes of the user. Maximum number of entries: 100
get.responses.200.content.application/json.remote_display_id?
Section titled “get.responses.200.content.application/json.remote_display_id?”
optionalremote_display_id?:string|null
Description
Section titled “Description”Identifier that is displayed on the IDP or HR system, eg, if OKTA identifies you as user xyz
get.responses.200.content.application/json.status?
Section titled “get.responses.200.content.application/json.status?”
optionalstatus?:"ACTIVE"|"DISABLED"|"ARCHIVED"|"DELETED"|"INACTIVE"|"INVITED"|"PENDING_ACTIVATION"|"CLOSED"|null
get.responses.200.content.application/json.title_id?
Section titled “get.responses.200.content.application/json.title_id?”
optionaltitle_id?:string|null
get.responses.200.headers
Section titled “get.responses.200.headers”headers:
object
Index Signature
Section titled “Index Signature”[name: string]: unknown
optionalhead?:undefined
options?
Section titled “options?”
optionaloptions?:undefined
parameters
Section titled “parameters”parameters:
object
parameters.cookie?
Section titled “parameters.cookie?”
optionalcookie?:undefined
parameters.header?
Section titled “parameters.header?”
optionalheader?:undefined
parameters.path?
Section titled “parameters.path?”
optionalpath?:undefined
parameters.query?
Section titled “parameters.query?”
optionalquery?:undefined
patch?
Section titled “patch?”
optionalpatch?:undefined
optionalpost?:undefined
optionalput?:undefined
trace?
Section titled “trace?”
optionaltrace?:undefined