---
title: "Provision listing"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sureshake.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sureshake API › directory

`POST /v2/directory/listings`

## Request body

_Required._

- `subjectType` (`directory-provision-listing.subjectType`; string, required)
  - one of `"person"`, `"entity"`
- `subjectId` (`directory-provision-listing.subjectId`; string, optional)
  - minLength 1; maxLength 255
- `personSubjectKind` (`directory-provision-listing.personSubjectKind`; string, optional)
  - one of `"user"`, `"reference_entity"`; default `"user"`

## Example request

```json
{
  "subjectType": "person",
  "subjectId": "string",
  "personSubjectKind": "user"
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url https://api.sureshake.com/v2/directory/listings \
  --header 'Content-Type: application/json' \
  --data '
{
  "subjectType": "person",
  "subjectId": "string",
  "personSubjectKind": "user"
}
'
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/directory/listings';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({subjectType: 'person', subjectId: 'string', personSubjectKind: 'user'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sureshake.com/v2/directory/listings"

payload = {
    "subjectType": "person",
    "subjectId": "string",
    "personSubjectKind": "user"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": {
    "created": true,
    "listing": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "subjectType": "person",
      "subjectId": "string",
      "slug": "string",
      "ownerPublicationStatus": "draft",
      "moderationStatus": "allowed",
      "claimStatus": "not_claimable",
      "claimedByUserId": "string",
      "claimedAt": "2019-08-24T14:15:22Z",
      "publishedVersionId": "9786f1b1-ef7e-4f6a-94c4-c8eb67e924eb",
      "snapshot": {
        "identity": {
          "displayName": "string",
          "aliases": [
            "string"
          ],
          "avatarUrl": "http://example.com",
          "logoUrl": "http://example.com"
        },
        "overview": "string",
        "location": "string",
        "category": "string",
        "websiteUrl": "http://example.com",
        "socialLinks": [
          {
            "label": "string",
            "url": "http://example.com"
          }
        ],
        "experienceOrTeam": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "credentials": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "businessDetails": {
          "property1": null,
          "property2": null
        },
        "publicEvidence": [
          {
            "property1": null,
            "property2": null
          }
        ],
        "capitalProviderProfile": {
          "profileType": "vc_professional"
        },
        "directEmail": "user@example.com",
        "directPhone": "string",
        "streetAddress": "string"
      },
      "visibilityPolicy": {
        "sections": {
          "identity": true
        },
        "sensitiveFields": {
          "directEmail": false,
          "directPhone": false,
          "streetAddress": false
        }
      },
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`directory-provision-listing.response.200.data`; object, required)
  - `created` (`directory-provision-listing.response.200.data.created`; boolean, required)
  - `listing` (`directory-provision-listing.response.200.data.listing`; object, required)
    - `id` (`directory-provision-listing.response.200.data.listing.id`; string, required)
      - format `uuid`
    - `subjectType` (`directory-provision-listing.response.200.data.listing.subjectType`; string, required)
      - one of `"person"`, `"entity"`
    - `subjectId` (`directory-provision-listing.response.200.data.listing.subjectId`; string, required)
    - `slug` (`directory-provision-listing.response.200.data.listing.slug`; string, required)
    - `ownerPublicationStatus` (`directory-provision-listing.response.200.data.listing.ownerPublicationStatus`; string, required)
      - one of `"draft"`, `"published"`, `"unpublished"`
    - `moderationStatus` (`directory-provision-listing.response.200.data.listing.moderationStatus`; string, required)
      - one of `"allowed"`, `"blocked"`, `"archived"`
    - `claimStatus` (`directory-provision-listing.response.200.data.listing.claimStatus`; string, required)
      - one of `"not_claimable"`, `"unclaimed"`, `"claim_pending"`, `"claimed"`
    - `claimedByUserId` (`directory-provision-listing.response.200.data.listing.claimedByUserId`; string, required, nullable)
    - `claimedAt` (`directory-provision-listing.response.200.data.listing.claimedAt`; string, required, nullable)
      - format `date-time`
    - `publishedVersionId` (`directory-provision-listing.response.200.data.listing.publishedVersionId`; string, required, nullable)
      - format `uuid`
    - `snapshot` (`directory-provision-listing.response.200.data.listing.snapshot`; object, required)
      - `identity` (`directory-provision-listing.response.200.data.listing.snapshot.identity`; object, required)
        - `displayName` (`directory-provision-listing.response.200.data.listing.snapshot.identity.displayName`; string, required)
          - minLength 1; maxLength 255
        - `aliases` (`directory-provision-listing.response.200.data.listing.snapshot.identity.aliases`; array<string>, optional)
          - minLength 1; maxLength 255
        - `avatarUrl` (`directory-provision-listing.response.200.data.listing.snapshot.identity.avatarUrl`; string, optional, nullable)
          - format `uri`
        - `logoUrl` (`directory-provision-listing.response.200.data.listing.snapshot.identity.logoUrl`; string, optional, nullable)
          - format `uri`
      - `overview` (`directory-provision-listing.response.200.data.listing.snapshot.overview`; string, optional, nullable)
        - maxLength 5000
      - `location` (`directory-provision-listing.response.200.data.listing.snapshot.location`; string, optional, nullable)
        - maxLength 255
      - `category` (`directory-provision-listing.response.200.data.listing.snapshot.category`; string, optional, nullable)
        - maxLength 255
      - `websiteUrl` (`directory-provision-listing.response.200.data.listing.snapshot.websiteUrl`; string, optional, nullable)
        - format `uri`
      - `socialLinks` (`directory-provision-listing.response.200.data.listing.snapshot.socialLinks`; array<object>, optional)
        - `label` (`directory-provision-listing.response.200.data.listing.snapshot.socialLinks.label`; string, required)
          - minLength 1; maxLength 80
        - `url` (`directory-provision-listing.response.200.data.listing.snapshot.socialLinks.url`; string, required)
          - format `uri`
      - `experienceOrTeam` (`directory-provision-listing.response.200.data.listing.snapshot.experienceOrTeam`; array<map<unknown>>, optional)
      - `credentials` (`directory-provision-listing.response.200.data.listing.snapshot.credentials`; array<map<unknown>>, optional)
      - `businessDetails` (`directory-provision-listing.response.200.data.listing.snapshot.businessDetails`; map<unknown>, optional)
      - `publicEvidence` (`directory-provision-listing.response.200.data.listing.snapshot.publicEvidence`; array<map<unknown>>, optional)
      - `capitalProviderProfile` (`directory-provision-listing.response.200.data.listing.snapshot.capitalProviderProfile`; object, optional)
        - `profileType` (`directory-provision-listing.response.200.data.listing.snapshot.capitalProviderProfile.profileType`; string, required)
          - one of `"vc_professional"`, `"angel_investor"`, `"scout"`, `"family_office_professional"`, `"accelerator_or_venture_studio"`, `"corporate_venture_professional"`, `"other_approved_capital_provider"`
      - `directEmail` (`directory-provision-listing.response.200.data.listing.snapshot.directEmail`; string, optional, nullable)
        - format `email`
      - `directPhone` (`directory-provision-listing.response.200.data.listing.snapshot.directPhone`; string, optional, nullable)
        - minLength 3; maxLength 50
      - `streetAddress` (`directory-provision-listing.response.200.data.listing.snapshot.streetAddress`; string, optional, nullable)
        - minLength 3; maxLength 500
    - `visibilityPolicy` (`directory-provision-listing.response.200.data.listing.visibilityPolicy`; object, required)
      - `sections` (`directory-provision-listing.response.200.data.listing.visibilityPolicy.sections`; object, optional)
        - default `{"identity":true}`
        - `identity` (`directory-provision-listing.response.200.data.listing.visibilityPolicy.sections.identity`; boolean, optional)
        - `overview` (`directory-provision-listing.response.200.data.listing.visibilityPolicy.sections.overview`; boolean, optional)
        - `location` (`directory-provision-listing.response.200.data.listing.visibilityPolicy.sections.location`; boolean, optional)
        - `websiteSocial` (`directory-provision-listing.response.200.data.listing.visibilityPolicy.sections.websiteSocial`; boolean, optional)
        - `experienceTeam` (`directory-provision-listing.response.200.data.listing.visibilityPolicy.sections.experienceTeam`; boolean, optional)
        - `credentials` (`directory-provision-listing.response.200.data.listing.visibilityPolicy.sections.credentials`; boolean, optional)
        - `businessDetails` (`directory-provision-listing.response.200.data.listing.visibilityPolicy.sections.businessDetails`; boolean, optional)
        - `publicEvidence` (`directory-provision-listing.response.200.data.listing.visibilityPolicy.sections.publicEvidence`; boolean, optional)
      - `sensitiveFields` (`directory-provision-listing.response.200.data.listing.visibilityPolicy.sensitiveFields`; object, optional)
        - default `{"directEmail":false,"directPhone":false,"streetAddress":false}`
        - `directEmail` (`directory-provision-listing.response.200.data.listing.visibilityPolicy.sensitiveFields.directEmail`; boolean, optional)
          - default `false`
        - `directPhone` (`directory-provision-listing.response.200.data.listing.visibilityPolicy.sensitiveFields.directPhone`; boolean, optional)
          - default `false`
        - `streetAddress` (`directory-provision-listing.response.200.data.listing.visibilityPolicy.sensitiveFields.streetAddress`; boolean, optional)
          - default `false`
    - `updatedAt` (`directory-provision-listing.response.200.data.listing.updatedAt`; string, required)
      - format `date-time`
- `meta` (`directory-provision-listing.response.200.meta`; object, optional)
  - `timestamp` (`directory-provision-listing.response.200.meta.timestamp`; string, required)
    - format `date-time`

### 400

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-provision-listing.response.400.error`; object, required)
  - `code` (`directory-provision-listing.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-provision-listing.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`directory-provision-listing.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-provision-listing.response.400.error.traceId`; string, optional) — Unique ID for log correlation

### 401

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-provision-listing.response.401.error`; object, required)
  - `code` (`directory-provision-listing.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-provision-listing.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`directory-provision-listing.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-provision-listing.response.401.error.traceId`; string, optional) — Unique ID for log correlation

### 403

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-provision-listing.response.403.error`; object, required)
  - `code` (`directory-provision-listing.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-provision-listing.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`directory-provision-listing.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-provision-listing.response.403.error.traceId`; string, optional) — Unique ID for log correlation

### 404

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-provision-listing.response.404.error`; object, required)
  - `code` (`directory-provision-listing.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-provision-listing.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`directory-provision-listing.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-provision-listing.response.404.error.traceId`; string, optional) — Unique ID for log correlation

### 409

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-provision-listing.response.409.error`; object, required)
  - `code` (`directory-provision-listing.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-provision-listing.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`directory-provision-listing.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-provision-listing.response.409.error.traceId`; string, optional) — Unique ID for log correlation

### 429

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-provision-listing.response.429.error`; object, required)
  - `code` (`directory-provision-listing.response.429.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-provision-listing.response.429.error.message`; string, required) — Human-readable error message
  - `details` (`directory-provision-listing.response.429.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-provision-listing.response.429.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-provision-listing.response.500.error`; object, required)
  - `code` (`directory-provision-listing.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-provision-listing.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`directory-provision-listing.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-provision-listing.response.500.error.traceId`; string, optional) — Unique ID for log correlation

### 503

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-provision-listing.response.503.error`; object, required)
  - `code` (`directory-provision-listing.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-provision-listing.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`directory-provision-listing.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-provision-listing.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/directory-provision-listing/index.md