Get business
GEThttps://api.publicsquare.com/business
Get the business details for the Account.
Permissions
business:read
Responses
- 200
- 400
- 401
- 403
- 404
OK
- application/json
- Schema
- Example (auto)
Schema
idstringnullable
Business ID
Example:
bus_AEMqSN2tWwKdEDepfRc7eSi51
account_idstringnullable
Account ID
Example:
acc_B518niGwGYKzig6vtrRVZGGGV
government_identifier_last4stringnullable
Last 4 of the SSN or EIN
Example:
9642
created_atdate-timenullable
Date business was created
Example:
2024-06-30T01:02:29.212Z
modified_atdate-timenullable
Date business was modified
Example:
2024-06-30T01:02:29.212Z
legal_namestringrequired
Legal name of the business
Possible values: non-empty
and <= 200 characters
Example:
Test Corporation, LLC
government_identifierstringnullable
SSN or EIN of the business
Example:
48-294876839
business_countrystringrequired
2 character ISO country code
Possible values: non-empty
and <= 2 characters
Example:
US
date_of_establishmentdate-timerequired
Date of establishment of the business
Example:
2016-04-07
business_websitestringrequired
Business website
Possible values: non-empty
and <= 250 characters
Example:
https://www.testcorporation.com
business_phonestringrequired
Business phone number
Possible values: non-empty
and <= 50 characters
Example:
+15552604982
business_typestringrequired
Business type
Possible values: non-empty
Example:
company
business_structurestringnullable
Business structure
Example:
private_corporation
business_structure_otherstringnullable
Business structure description if business structure is 'other'
Possible values: <= 100 characters
Example:
Custom business structure
is_firearms_merchantbooleannullable
Does the business manufacture, distribute, or sell firearms?
Example:
true
headquarters_address objectrequired
{
"id": "bus_AEMqSN2tWwKdEDepfRc7eSi51",
"account_id": "acc_B518niGwGYKzig6vtrRVZGGGV",
"government_identifier_last4": "9642",
"created_at": "2024-06-30T01:02:29.212Z",
"modified_at": "2024-06-30T01:02:29.212Z",
"legal_name": "Test Corporation, LLC",
"government_identifier": "48-294876839",
"business_country": "US",
"date_of_establishment": "2016-04-07",
"business_website": "https://www.testcorporation.com",
"business_phone": "+15552604982",
"business_type": "company",
"business_structure": "private_corporation",
"business_structure_other": "Custom business structure",
"is_firearms_merchant": true,
"headquarters_address": {
"address_line_1": "111 Colorado Ave.",
"address_line_2": "Apt 403",
"city": "Des Moines",
"state": "IA",
"postal_code": "51111",
"country": "US"
}
}
Bad Request
- application/json
- Schema
- Example (auto)
Schema
errors objectnullable
typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any
{
"errors": {},
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
Unauthorized
- application/json
- Schema
- Example (auto)
Schema
typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
Forbidden
- application/json
- Schema
- Example (auto)
Schema
typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
Not Found
- application/json
- Schema
- Example (auto)
Schema
typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
Authorization: X-API-KEY
name: X-API-KEYtype: apiKeyscopes: business:read
description: Authorization by API Key inside request's X-API-KEY headerin: header
- csharp
- curl
- dart
- go
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- powershell
- python
- r
- ruby
- rust
- shell
- swift
- HTTPCLIENT
- RESTSHARP
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.publicsquare.com/business");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("X-API-KEY", "<X-API-KEY>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
ResponseClear