Platform Status: Good

V1.5

Join Free

API Reference

Quickly review all available resources for the PORT API. Learn the basics of the PORT API in our Get Started guide.

Data Types

HTTP Method

Endpoint

Function

GET

/datatypes

Lists all available Data Types

Entity

HTTP Method

Endpoint

Function

GET

/users/{user_id}/entities

Gets all entities for a user

POST

/users/{user_id}/entities

Creates a new entity

GET

/users/{user_id}/entities/{entity_id}

Gets an entity

PUT

/users/{user_id}/entities/{entity_id}

Replace an entity

PATCH

/users/{user_id}/entities/{entity_id}

Partially update an entity

DELETE

/users/{user_id}/entities/{entity_id}

Deletes an entity

Events

HTTP Method

Endpoint

Function

List events

Get an event

Segments

HTTP Method

Endpoint

Function

GET

/segments

Gets a list of all segments

POST

/segments

Creates a segment

GET

/segments/{segment_id}

Gets a segment

DELETE

/segments/{segment_id}

Deletes a segment

Users

HTTP Method

Endpoint

Function

GET

/users

Gets a list of all users

Creates a user

Gets a user

Deletes a user

Updates a user