public

List public companies

SecurityNone

Request

query Parameters

id	string
id__contains	string
name	string
name__contains	string
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/3/public/companies/

Request samples

Python SDK

rehive.public.companies.get()

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": "string",
"name": "string",
"description": "string",
"website": "http://example.com",
"support_website": "http://example.com",
"documentation_website": "http://example.com",
"support_email": "user@example.com",
"contact_email": "user@example.com",
"country": "AF",
"logo": "http://example.com",
"icon": "http://example.com",
"metadata": {"property1": null,
"property2": null
},
"settings": {"allow_session_durations": true,
"terms_and_conditions_url": "http://example.com",
"privacy_policy_url": "http://example.com",
"nationalities": ["AF"
],
"residencies": ["AF"
]
},
"services": [{"id": 0,
"slug": "string",
"name": "string",
"url": "string",
"type": "system"
}
],
"mode": "test",
"status": "pending",
"use_new_documents_and_requirement_sets": true,
"created": 0,
"updated": 0
}
]
}
}

Retrieve public company

SecurityNone

Request

path Parameters

required

string^\w+$

Responses

200

get/3/public/companies/{id}/

Request samples

Python SDK

rehive.public.companies.get(company_id)

Response samples

application/json

{"status": "success",
"data": {"id": "string",
"name": "string",
"description": "string",
"website": "http://example.com",
"support_website": "http://example.com",
"documentation_website": "http://example.com",
"support_email": "user@example.com",
"contact_email": "user@example.com",
"country": "AF",
"logo": "http://example.com",
"icon": "http://example.com",
"metadata": {"property1": null,
"property2": null
},
"settings": {"allow_session_durations": true,
"terms_and_conditions_url": "http://example.com",
"privacy_policy_url": "http://example.com",
"nationalities": ["AF"
],
"residencies": ["AF"
]
},
"services": [{"id": 0,
"slug": "string",
"name": "string",
"url": "string",
"type": "system"
}
],
"mode": "test",
"status": "pending",
"use_new_documents_and_requirement_sets": true,
"created": 0,
"updated": 0
}
}

List public company groups

SecurityNone

Request

path Parameters

required

string^\w+$

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/3/public/companies/{id}/groups/

Request samples

Python SDK

rehive.public.companies.obj(company_id).groups.get()

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"name": "string",
"label": "string",
"section": "system",
"description": "string",
"icon": "http://example.com",
"default": true
}
]
}
}

Retrieve public company group

SecurityNone

Request

path Parameters

group_name required	string^\w+$
id required	string^\w+$

Responses

200

get/3/public/companies/{id}/groups/{group_name}/

Request samples

Python SDK

rehive.public.companies.obj(company_id).groups.get(group_name)

Response samples

application/json

{"status": "success",
"data": {"name": "string",
"label": "string",
"section": "system",
"description": "string",
"icon": "http://example.com",
"default": true
}
}

List public company legal terms

SecurityNone

Request

path Parameters

required

string^\w+$

query Parameters

group	string
name	string
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
type	string

Responses

200

get/3/public/companies/{id}/legal-terms/

Request samples

Python SDK

rehive.public.companies.obj(company_id).legal_terms.get()

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"type": "system",
"name": "string",
"description": "string",
"groups": ["string"
],
"versions": [{"id": 0,
"version": 0
}
],
"created": 0,
"updated": 0
}
]
}
}

Retrieve public company legal terms

SecurityNone

Request

path Parameters

id required	string^\w+$
term_id required	string^\d+$

Responses

200

get/3/public/companies/{id}/legal-terms/{term_id}/

Request samples

Python SDK

rehive.public.companies.obj(company_id).legal_terms.get(
  legal_term_id
)

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"type": "system",
"name": "string",
"description": "string",
"groups": ["string"
],
"versions": [{"id": 0,
"version": 0
}
],
"created": 0,
"updated": 0
}
}

List public company legal term versions

SecurityNone

Request

path Parameters

id required	string^\w+$
term_id required	string^\d+$

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/3/public/companies/{id}/legal-terms/{term_id}/versions/

Request samples

Python SDK

rehive.public.companies.obj(company_id).legal_terms.get(
  legal_term_id
).versions.get()

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"version": 0,
"note": "string",
"content": "string",
"created": 0,
"updated": 0
}
]
}
}

Retrieve public company legal term version

SecurityNone

Request

path Parameters

id required	string^\w+$
term_id required	string^\d+$
version_id required	string^\d+$

Responses

200

get/3/public/companies/{id}/legal-terms/{term_id}/versions/{version_id}/

Request samples

Python SDK

rehive.public.companies.obj(company_id).legal_terms.get(
  legal_term_id
).versions.get(version_id)

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"version": 0,
"note": "string",
"content": "string",
"created": 0,
"updated": 0
}
}

List public legal terms

SecurityNone

Request

query Parameters

group	string
name	string
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
type	string

Responses

200

get/3/public/legal-terms/

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"type": "system",
"name": "string",
"description": "string",
"groups": ["string"
],
"versions": [{"id": 0,
"version": 0
}
],
"created": 0,
"updated": 0
}
]
}
}

Retrieve public legal terms

SecurityNone

Request

path Parameters

term_id

required

string^\d+$

Responses

200

get/3/public/legal-terms/{term_id}/

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"type": "system",
"name": "string",
"description": "string",
"groups": ["string"
],
"versions": [{"id": 0,
"version": 0
}
],
"created": 0,
"updated": 0
}
}

List public legal term versions

SecurityNone

Request

path Parameters

term_id

required

string^\d+$

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/3/public/legal-terms/{term_id}/versions/

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"version": 0,
"note": "string",
"content": "string",
"created": 0,
"updated": 0
}
]
}
}

Retrieve public legal term version

SecurityNone

Request

path Parameters

term_id required	string^\d+$
version_id required	string^\d+$

Responses

200

get/3/public/legal-terms/{term_id}/versions/{version_id}/

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"version": 0,
"note": "string",
"content": "string",
"created": 0,
"updated": 0
}
}

➔ Next to subtypes