https://api.payload.com/orgs
Nested Objects
https://api.payload.com/orgs/{id}/legal_entity
https://api.payload.com/orgs/{id}/logo
https://api.payload.com/orgs/{id}/processing_settings
Example
{
"id": "acct_mwgPNNqxlP2LX0BiNStPb4uC",
"object": "org",
"attrs": {},
"created_at": "2024-08-21 13:35:03",
"environ": "string",
"industry": "string",
"legal_entity_id": "le_1suevojb9P5St8VhWuysiPun3",
"modified_at": "2024-08-21 13:35:03",
"name": "string",
"org_type": "string",
"parent_org_id": "acct_1AYYidDoszOYQG1wFSwFiLMka",
"phone_number": "(123) 456-7890",
"primary_processing_id": "acct_1AsxGM3QWrmgsjFVVmIbh14CS",
"processing_settings": {},
"processing_settings_id": "ps_lgWMxEz05WSTyi58msb3Sth6",
"timezone": "string"
}
Attributes | Description |
---|---|
id string readonly |
Object ID |
object string readonly |
Value: org |
attrs json |
Custom object attributes |
created_at datetime readonly |
None |
environ string |
environ of account |
industry string required |
Primary processing industry |
legal_entity_id id |
ID of associated legal entity |
modified_at datetime readonly |
None |
name string required |
Name of the organization |
org_type string required |
Type of organization |
parent_org_id id |
Specify the parent org for an account |
phone_number phone |
Phone number for the organization |
primary_processing_id id |
Specify the primary processing account for the account |
processing_settings object |
Associated Processing Setting object |
processing_settings_id id readonly: update |
ID of the associated processing settings |
timezone string |
The primary timezone for the account |