Sign in
entities

Create an entity

Changed on

Create a private workspace entity using the canonical nested address and contact request shape. Publish separately after adding a source.

Use this entity operation to find or manage source-backed civic actors. Preserve entity ids, source ids, place context, and issue filters whenever you export or reuse results.

post/api/entities

Request

  • Base URL: https://atlas.rebuildingus.org
  • URL: https://atlas.rebuildingus.org/api/entities
  • Auth: none declared

Headers

x-api-keystring nullable

Request body

affiliated_org_idstring nullable

Affiliated organization ID

citystring nullable

Legacy flat city

contact_statusstring

Contact status

descriptionstring required

1-3 sentence description

editorial_notesstring nullable

Internal notes

emailstring nullable

Legacy flat email

first_seenstring date nullable

First discovery date

full_addressstring nullable

Legacy flat full address

geo_specificitystring nullable

Legacy flat geographic scope

issue_area_idsstring[]

Canonical issue-area IDs

issue_areasstring[]

Legacy issue-area slugs

last_seenstring date nullable

Last discovery date

namestring required

Entity name

phonestring nullable

Legacy flat phone

prioritystring nullable

Priority level

regionstring nullable

Legacy flat region

social_mediaobject nullable

Legacy flat social media

statestring nullable

Legacy flat state

typestring required

Entity type

websitestring nullable

Legacy flat website

Example request

{
  "type": "person"
}

Response

The newly created Atlas entity.

action_urlstring nullable

Reviewed official page where a visitor can take a next step.

activeboolean required

active for this entity detail.

affiliated_org_idstring nullable

affiliated org id for this entity detail.

created_atstring required

created at for this entity detail.

custom_biostring nullable

Subject-authored bio that overrides the auto-generated description on display.

descriptionstring required

description for this entity detail.

idstring required

id for this entity detail.

issue_area_idsstring[]

issue area ids for this entity detail.

namestring required

name for this entity detail.

photo_urlstring nullable

Subject-uploaded photo or org logo. Null until a verified subject uploads one.

preferred_contact_channelstring nullable

Subject preference for which channel readers should use to make contact.

profile_urlstring nullable

Absolute URL to the entity's public profile page, when derivable.

relationship_idsstring[]

relationship ids for this entity detail.

resource_uristring required

resource uri for this entity detail.

slugstring nullable

Human-readable URL slug (e.g., jane-doe-a3f2).

source_countinteger

source count for this entity detail.

source_idsstring[]

source ids for this entity detail.

source_typesstring[]

source types for this entity detail.

typestring required

type for this entity detail.

updated_atstring required

updated at for this entity detail.

verifiedboolean required

verified for this entity detail.

Changes

  • 6ea72ce93d40Revision changes
    • warning

      deleted the header request parameter x-atlas-actor-email

    • warning

      deleted the header request parameter x-atlas-actor-id

    • warning

      deleted the header request parameter x-atlas-internal-secret

    • warning

      deleted the header request parameter x-atlas-organization-id

  • 32bd078ed621Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status