Organizations
View your organizations
All accounts (personal and business accounts) have an organization and org ID. To access your data you must include the organization ID in request paths (e.g. GET /api/v1/orgs/:org_id/contacts
).
Fetch your organizations
GET
https://web.r0app.com/api/v1/orgs
Example request
curl https://web.r0app.com/api/v1/orgs \
-X GET \
-H 'Authorization: Bearer <token>'
Add organization address
Add an organization's address
POST
https://web.r0app.com/api/v1/orgs/:org_id/addresses
Request Body
Name
Type
Description
address[address_line_1]*
String
address[address_line_2]
String
address[address_line_3]
String
address[locality]*
String
address[region]*
String
address[postcode]*
String
address[country]*
String
Example request
curl https://web.r0app.com/api/v1/orgs/:org_id/addresses \
-X POST \
-H 'Authorization: Bearer <token>' \
-d 'address[address_line_1]=742 Evergreen Terrace' \
-d 'address[address_line_2]=Attn. Homer Simpson' \
-d 'address[locality]=Springfield' \
-d 'address[region]=Anystate' \
-d 'address[postcode]=54321' \
-d 'address[country]=United States of America'
Edit organization address
Update an organization's address
PATCH
https://web.r0app.com/api/v1/orgs/:org_id/addresses/:address_id
Request Body
Name
Type
Description
address[address_line_1]
String
address[address_line_2]
String
address[address_line_3]
String
address[locality]
String
address[region]
String
address[postcode]
String
address[country]
String
Example request
curl https://web.r0app.com/api/v1/orgs/:org_id/addresses/:address_id \
-X PATCH \
-H 'Authorization: Bearer <token>' \
-d 'address[address_line_1]=742 Evergreen Terrace' \
-d 'address[postcode]=12345'
Last updated
Was this helpful?