OmniStream CRM API
stringstringinteger · min: 1integer · min: 1 · max: 100string · uuid · requiredstring · requiredstring[] · requiredstring · date-time · requiredstring · date-time · requiredstringstringstring · email
string · uuid · requiredstring · uuid · requiredstring · requiredstring[] · requiredstring · date-time · requiredstring · date-time · requiredstringstringstring · email
string · uuid · required
string · uuid · requiredintegerintegerstring · uuid · requiredstring · uuid · requiredstring · enum · requiredstring · date-time · requiredinteger · requiredstring · date-time · requiredstring · date-time · requiredstring · requiredstring · uuidstringstring
Contact management
List contacts
GET
https://api-chat.bara.my.id
/api/contacts
query Parameters
searchSearch by name, phone, or email (case-insensitive)
tagFilter by tag (JSONB containment)
pageDefault: 1
per_pageDefault: 20
List contacts › Responses
200
List of contacts
object[]
idchannel_sourcewhatsapp, instagram, or email
tagsJSON array of tag strings
created_atupdated_atphone_numbernameemailGet a contact by ID
GET
https://api-chat.bara.my.id
/api/contacts/{id}
path Parameters
idGet a contact by ID › Responses
Contact details
idchannel_sourcewhatsapp, instagram, or email
tagsJSON array of tag strings
created_atupdated_atphone_numbernameemailUpdate a contact
PATCH
https://api-chat.bara.my.id
/api/contacts/{id}
Update name, email, or tags. At least one field required.
path Parameters
idUpdate a contact › Request Body
At least one field required.
nameemailtagsUpdate a contact › Responses
200
Updated contact
idchannel_sourcewhatsapp, instagram, or email
tagsJSON array of tag strings
created_atupdated_atphone_numbernameemailList conversations for a contact
GET
https://api-chat.bara.my.id
/api/contacts/{id}/conversations
path Parameters
idquery Parameters
pageDefault: 1
per_pageDefault: 20
List conversations for a contact › Responses
200
Conversations for this contact
object[]
idcontact_idstatusEnum values:
open
pending
resolved
expired
last_message_atunread_countcreated_atupdated_atcontact_channelwhatsapp, instagram, or email
assigned_agent_idcontact_namecontact_phone