Documentation Guides API Reference Data Types Entity Events Segments Users Object Types Event Types Changelog
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

GET
/events
List events
GET
/events/{event_id}
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
POST
/users
Creates a user
GET
/users/{user_id}
Gets a user
DELETE
/users/{user_id}
Deletes a user
PATCH
/users/{user_id}
Updates a user