{"_id":"55a50e94ec735f37000fc6e5","slug":"getting-started","title":"Getting Started with mobilize","type":"basic","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"link_url":"","githubsync":"","sync_unique":"","version":"55a50e92ec735f37000fc6e2","body":"The Mobilize API is based on RESTful principles; we also use HTTP authentication standards and HTTP methods to make the Mobilize API as easy to use as possible.\n\nWe welcome your feedback with regards to issues and improvements. Please contact your customer success manager at [[email protected]](mailto:[email protected]) with any questions or comments.. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Versioning\"\n}\n[/block]\nThe current API version is V1.\nThe version number will change any time there is a change that is not backward compatible.\nYou can access to the current version at https://api.mobilize.io/v1/\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Requesting Access\"\n}\n[/block]\nYour community admin user may **generate an API keys** by going to\n community settings > Integrations > generate API keys.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/DXUNQS1sQZie6CiHm5hw_Screen%20Shot%202015-08-18%20at%202.06.10%20PM.png\",\n        \"Screen Shot 2015-08-18 at 2.06.10 PM.png\",\n        \"1026\",\n        \"248\",\n        \"#05bcbc\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"API Secret\",\n  \"body\": \"Please Keep the secret key in a safe place. We will not show the secret key again after the initial display.\"\n}\n[/block]\nFor now we support only one integration key per community. if you wish to have more than one API key please contact your customer success manager at [[email protected]](mailto:[email protected]) to ask for additional API keys.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Privacy and privilege\"\n}\n[/block]\nThe Network admin has the highest privileges to their community.\nAll of your API requests will have the same privileges as the community admin.\n\nNote: Temporary keys to test the API before launching a production version are not provided at this time.\n**Please test your code carefully before launching to an existing community.** \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Security and Authentication\"\n}\n[/block]\nAPI requests are authenticated using standard HTTP Basic authentication.\nYou must use the key to authenticate on each API call.\n**Basic Authentication:** \nuser name : [ API KEY ]\npassword : [ API SECRET ]\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"REQUEST\\ncurl -X GET https://api.mobilize.io/v1/groups\\n  -u [API KEY]:[API SECRET]\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"HTTP Operations\"\n}\n[/block]\nWe are a RESTful API with an endpoint of https://api.mobilize.io. All responses will be returned in JSON format.\n\n  * **GET**: retrieve an object or set of objects.\n  * **POST**: add a new object.\n  * **PUT**: update an existing object.\n  * **DELETE**: remove an object. \n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"\",\n  \"body\": \"Not all API end points support all operations at this time.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Error Codes\"\n}\n[/block]\nThe API supports HTTP response standard error code. \n200 is for successful request. 4xx are for error requests and 5xx are for unexpected server errors.\n**HTTP Status Codes:**\n**200** Ok - *normal successful request*\n**400** Bad Request - *normally a missing or malformatted parameter*\n**401** Unauthorized - *missing credentials*\n**403** Forbidden - *provided key does not have access for that method*\n**404** Not Found - *requested object does not exist*\n**422** Unprocessable Entity - *often the posted object is malformatted*\n**500** Server Error - *an unexpected error on the parameters*\n**503** Service Unavailable - *likely a deploy is occurring or migration.* \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Definition\",\n    \"0-0\": \"status_code\",\n    \"0-1\": \"Numeric\",\n    \"0-2\": \"http status code.\",\n    \"1-0\": \"error_message\",\n    \"1-1\": \"Text\",\n    \"1-2\": \"error message to help the developer to understand the problem.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"REQUEST\\ncurl -X GET https://api.mobilize.io/v1/group/{id}\\n  -u [API Key]:[API Secret]\\n\\nRESPONSE\\nHTTP/1.1 404 NOT FOUND\\n{\\n  \\\"status_code\\\": 404,\\n  \\\"error_message\\\": \\\"Group {id} not found\\\"\\n}\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]","createdAt":"2015-07-14T13:28:52.521Z","excerpt":"You'll be up and running in a jiffy!","link_external":false,"user":"55a50dd1750a9a23005332c6","category":"55a50e93ec735f37000fc6e3","order":0,"project":"55a50e92ec735f37000fc6df","updates":["6094ea8022817300473c3cf6"],"__v":30,"hidden":false,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"isReference":false,"next":{"description":"","pages":[]},"childrenPages":[]}

Getting Started with mobilize

You'll be up and running in a jiffy!

The Mobilize API is based on RESTful principles; we also use HTTP authentication standards and HTTP methods to make the Mobilize API as easy to use as possible. We welcome your feedback with regards to issues and improvements. Please contact your customer success manager at [[email protected]](mailto:[email protected]) with any questions or comments.. [block:api-header] { "type": "basic", "title": "Versioning" } [/block] The current API version is V1. The version number will change any time there is a change that is not backward compatible. You can access to the current version at https://api.mobilize.io/v1/ [block:api-header] { "type": "basic", "title": "Requesting Access" } [/block] Your community admin user may **generate an API keys** by going to community settings > Integrations > generate API keys. [block:image] { "images": [ { "image": [ "https://files.readme.io/DXUNQS1sQZie6CiHm5hw_Screen%20Shot%202015-08-18%20at%202.06.10%20PM.png", "Screen Shot 2015-08-18 at 2.06.10 PM.png", "1026", "248", "#05bcbc", "" ] } ] } [/block] [block:callout] { "type": "warning", "title": "API Secret", "body": "Please Keep the secret key in a safe place. We will not show the secret key again after the initial display." } [/block] For now we support only one integration key per community. if you wish to have more than one API key please contact your customer success manager at [[email protected]](mailto:[email protected]) to ask for additional API keys. [block:api-header] { "type": "basic", "title": "Privacy and privilege" } [/block] The Network admin has the highest privileges to their community. All of your API requests will have the same privileges as the community admin. Note: Temporary keys to test the API before launching a production version are not provided at this time. **Please test your code carefully before launching to an existing community.** [block:api-header] { "type": "basic", "title": "Security and Authentication" } [/block] API requests are authenticated using standard HTTP Basic authentication. You must use the key to authenticate on each API call. **Basic Authentication:** user name : [ API KEY ] password : [ API SECRET ] [block:code] { "codes": [ { "code": "REQUEST\ncurl -X GET https://api.mobilize.io/v1/groups\n -u [API KEY]:[API SECRET]", "language": "curl" } ] } [/block] [block:api-header] { "type": "basic", "title": "HTTP Operations" } [/block] We are a RESTful API with an endpoint of https://api.mobilize.io. All responses will be returned in JSON format. * **GET**: retrieve an object or set of objects. * **POST**: add a new object. * **PUT**: update an existing object. * **DELETE**: remove an object. [block:callout] { "type": "info", "title": "", "body": "Not all API end points support all operations at this time." } [/block] [block:api-header] { "type": "basic", "title": "Error Codes" } [/block] The API supports HTTP response standard error code. 200 is for successful request. 4xx are for error requests and 5xx are for unexpected server errors. **HTTP Status Codes:** **200** Ok - *normal successful request* **400** Bad Request - *normally a missing or malformatted parameter* **401** Unauthorized - *missing credentials* **403** Forbidden - *provided key does not have access for that method* **404** Not Found - *requested object does not exist* **422** Unprocessable Entity - *often the posted object is malformatted* **500** Server Error - *an unexpected error on the parameters* **503** Service Unavailable - *likely a deploy is occurring or migration.* [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Definition", "0-0": "status_code", "0-1": "Numeric", "0-2": "http status code.", "1-0": "error_message", "1-1": "Text", "1-2": "error message to help the developer to understand the problem." }, "cols": 3, "rows": 2 } [/block] [block:code] { "codes": [ { "code": "REQUEST\ncurl -X GET https://api.mobilize.io/v1/group/{id}\n -u [API Key]:[API Secret]\n\nRESPONSE\nHTTP/1.1 404 NOT FOUND\n{\n \"status_code\": 404,\n \"error_message\": \"Group {id} not found\"\n}", "language": "curl" } ] } [/block]
The Mobilize API is based on RESTful principles; we also use HTTP authentication standards and HTTP methods to make the Mobilize API as easy to use as possible. We welcome your feedback with regards to issues and improvements. Please contact your customer success manager at [[email protected]](mailto:[email protected]) with any questions or comments.. [block:api-header] { "type": "basic", "title": "Versioning" } [/block] The current API version is V1. The version number will change any time there is a change that is not backward compatible. You can access to the current version at https://api.mobilize.io/v1/ [block:api-header] { "type": "basic", "title": "Requesting Access" } [/block] Your community admin user may **generate an API keys** by going to community settings > Integrations > generate API keys. [block:image] { "images": [ { "image": [ "https://files.readme.io/DXUNQS1sQZie6CiHm5hw_Screen%20Shot%202015-08-18%20at%202.06.10%20PM.png", "Screen Shot 2015-08-18 at 2.06.10 PM.png", "1026", "248", "#05bcbc", "" ] } ] } [/block] [block:callout] { "type": "warning", "title": "API Secret", "body": "Please Keep the secret key in a safe place. We will not show the secret key again after the initial display." } [/block] For now we support only one integration key per community. if you wish to have more than one API key please contact your customer success manager at [[email protected]](mailto:[email protected]) to ask for additional API keys. [block:api-header] { "type": "basic", "title": "Privacy and privilege" } [/block] The Network admin has the highest privileges to their community. All of your API requests will have the same privileges as the community admin. Note: Temporary keys to test the API before launching a production version are not provided at this time. **Please test your code carefully before launching to an existing community.** [block:api-header] { "type": "basic", "title": "Security and Authentication" } [/block] API requests are authenticated using standard HTTP Basic authentication. You must use the key to authenticate on each API call. **Basic Authentication:** user name : [ API KEY ] password : [ API SECRET ] [block:code] { "codes": [ { "code": "REQUEST\ncurl -X GET https://api.mobilize.io/v1/groups\n -u [API KEY]:[API SECRET]", "language": "curl" } ] } [/block] [block:api-header] { "type": "basic", "title": "HTTP Operations" } [/block] We are a RESTful API with an endpoint of https://api.mobilize.io. All responses will be returned in JSON format. * **GET**: retrieve an object or set of objects. * **POST**: add a new object. * **PUT**: update an existing object. * **DELETE**: remove an object. [block:callout] { "type": "info", "title": "", "body": "Not all API end points support all operations at this time." } [/block] [block:api-header] { "type": "basic", "title": "Error Codes" } [/block] The API supports HTTP response standard error code. 200 is for successful request. 4xx are for error requests and 5xx are for unexpected server errors. **HTTP Status Codes:** **200** Ok - *normal successful request* **400** Bad Request - *normally a missing or malformatted parameter* **401** Unauthorized - *missing credentials* **403** Forbidden - *provided key does not have access for that method* **404** Not Found - *requested object does not exist* **422** Unprocessable Entity - *often the posted object is malformatted* **500** Server Error - *an unexpected error on the parameters* **503** Service Unavailable - *likely a deploy is occurring or migration.* [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Definition", "0-0": "status_code", "0-1": "Numeric", "0-2": "http status code.", "1-0": "error_message", "1-1": "Text", "1-2": "error message to help the developer to understand the problem." }, "cols": 3, "rows": 2 } [/block] [block:code] { "codes": [ { "code": "REQUEST\ncurl -X GET https://api.mobilize.io/v1/group/{id}\n -u [API Key]:[API Secret]\n\nRESPONSE\nHTTP/1.1 404 NOT FOUND\n{\n \"status_code\": 404,\n \"error_message\": \"Group {id} not found\"\n}", "language": "curl" } ] } [/block]
{"_id":"55a60882249a40190051d909","createdAt":"2015-07-15T07:15:14.537Z","project":"55a50e92ec735f37000fc6df","slug":"groups","type":"basic","api":{"settings":"","url":"","auth":"required","params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]}},"githubsync":"","link_url":"","order":0,"title":"Group Object","version":"55a50e92ec735f37000fc6e2","__v":21,"body":"Group represents a community group.\nGroups are tied to your community and community may have as many groups as limited by the community subscription plan.\n\nGroups are ordered in a hierarchy so for some groups you will see a parent id property.\nThe hierarchy of the groups is structured in a way that the parent group will always contain the members of the child groups, Therefor when you add a member to a child group it automatically adds him to its parent groups. The same applies when you remove a member from a parent group, it automatically removes him from the child groups.\n\nEach group has an array of fields that the admin may define in order to collect more data from the members. The basic fields are: First Name, Last Name and Email. \nAll the fields that are defined for a certain group will be inherited to the children group. \nmeaning that if an admin of a parent group creates a field, the field will automatically be propagated to the sub-groups and the removal of this field will be possible only from the parent group that originated this field.\n\nThe API may access all of your community groups and their data.\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"For now we only support group view and not creation functionality.\\nPlease contact your customer success manager with any questions or comments.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Group Object\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"DEFINITION\\n{\\n    \\\"id\\\" : {Numeric},\\n    \\\"name\\\" : {Text},\\n\\t  \\\"email\\\":{Text},\\n\\t\\t\\\"logo\\\": {\\n      url:{Text}\\n      small_thumb:{Text},\\n\\t\\t  mini_thumb:{Text},\\n  \\t\\tthumb:{Text}\\n    }  \\t\\t\\n    \\\"fields\\\": [\\n      {\\n        \\\"id\\\":{Numeric}\\n        \\\"name\\\":{Text}\\n      \\t...\\n      },\\n      ...\\n    ]\\n\\t\\t...\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Definition\",\n    \"0-0\": \"id\",\n    \"0-1\": \"Numeric\",\n    \"0-2\": \"This is a unique identifier associated to each of your groups.\",\n    \"1-0\": \"name\",\n    \"1-1\": \"Text\",\n    \"1-2\": \"This is the group name. limited to 255 chars.\",\n    \"2-0\": \"email\",\n    \"2-1\": \"Text\",\n    \"2-2\": \"This is the group email address. by sending a message to this address users can post directly to the group without the need to login.\",\n    \"3-0\": \"parent_group\",\n    \"3-2\": \"This is a unique identifier associated with a parent group.\",\n    \"3-1\": \"Numeric\",\n    \"4-0\": \"logo\",\n    \"4-1\": \"Object\",\n    \"4-2\": \"The group logo image url\",\n    \"5-0\": \"created_at\",\n    \"5-1\": \"Numeric\",\n    \"5-2\": \"The time this object was created, in UTC milliseconds past the epoch. This field is automatically updated by writing queries and not directly editable.\",\n    \"6-0\": \"update_at\",\n    \"6-1\": \"Numeric\",\n    \"6-2\": \"The time this object was last modified, in UTC milliseconds past the epoch. This field is automatically updated by writing queries and not directly editable.\",\n    \"7-0\": \"fields\",\n    \"7-1\": \"Array[FieldDefinition]\",\n    \"7-2\": \"An array of fields\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]","category":"55a603ce249a40190051d8f7","excerpt":"","link_external":false,"hidden":false,"sync_unique":"","updates":[],"user":"55a5d68c80c8a30d00b32498","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Group Object


Group represents a community group. Groups are tied to your community and community may have as many groups as limited by the community subscription plan. Groups are ordered in a hierarchy so for some groups you will see a parent id property. The hierarchy of the groups is structured in a way that the parent group will always contain the members of the child groups, Therefor when you add a member to a child group it automatically adds him to its parent groups. The same applies when you remove a member from a parent group, it automatically removes him from the child groups. Each group has an array of fields that the admin may define in order to collect more data from the members. The basic fields are: First Name, Last Name and Email. All the fields that are defined for a certain group will be inherited to the children group. meaning that if an admin of a parent group creates a field, the field will automatically be propagated to the sub-groups and the removal of this field will be possible only from the parent group that originated this field. The API may access all of your community groups and their data. [block:callout] { "type": "info", "body": "For now we only support group view and not creation functionality.\nPlease contact your customer success manager with any questions or comments." } [/block] [block:api-header] { "type": "basic", "title": "Group Object" } [/block] [block:code] { "codes": [ { "code": "DEFINITION\n{\n \"id\" : {Numeric},\n \"name\" : {Text},\n\t \"email\":{Text},\n\t\t\"logo\": {\n url:{Text}\n small_thumb:{Text},\n\t\t mini_thumb:{Text},\n \t\tthumb:{Text}\n } \t\t\n \"fields\": [\n {\n \"id\":{Numeric}\n \"name\":{Text}\n \t...\n },\n ...\n ]\n\t\t...\n}", "language": "json" } ], "sidebar": true } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Definition", "0-0": "id", "0-1": "Numeric", "0-2": "This is a unique identifier associated to each of your groups.", "1-0": "name", "1-1": "Text", "1-2": "This is the group name. limited to 255 chars.", "2-0": "email", "2-1": "Text", "2-2": "This is the group email address. by sending a message to this address users can post directly to the group without the need to login.", "3-0": "parent_group", "3-2": "This is a unique identifier associated with a parent group.", "3-1": "Numeric", "4-0": "logo", "4-1": "Object", "4-2": "The group logo image url", "5-0": "created_at", "5-1": "Numeric", "5-2": "The time this object was created, in UTC milliseconds past the epoch. This field is automatically updated by writing queries and not directly editable.", "6-0": "update_at", "6-1": "Numeric", "6-2": "The time this object was last modified, in UTC milliseconds past the epoch. This field is automatically updated by writing queries and not directly editable.", "7-0": "fields", "7-1": "Array[FieldDefinition]", "7-2": "An array of fields" }, "cols": 3, "rows": 8 } [/block]
Group represents a community group. Groups are tied to your community and community may have as many groups as limited by the community subscription plan. Groups are ordered in a hierarchy so for some groups you will see a parent id property. The hierarchy of the groups is structured in a way that the parent group will always contain the members of the child groups, Therefor when you add a member to a child group it automatically adds him to its parent groups. The same applies when you remove a member from a parent group, it automatically removes him from the child groups. Each group has an array of fields that the admin may define in order to collect more data from the members. The basic fields are: First Name, Last Name and Email. All the fields that are defined for a certain group will be inherited to the children group. meaning that if an admin of a parent group creates a field, the field will automatically be propagated to the sub-groups and the removal of this field will be possible only from the parent group that originated this field. The API may access all of your community groups and their data. [block:callout] { "type": "info", "body": "For now we only support group view and not creation functionality.\nPlease contact your customer success manager with any questions or comments." } [/block] [block:api-header] { "type": "basic", "title": "Group Object" } [/block] [block:code] { "codes": [ { "code": "DEFINITION\n{\n \"id\" : {Numeric},\n \"name\" : {Text},\n\t \"email\":{Text},\n\t\t\"logo\": {\n url:{Text}\n small_thumb:{Text},\n\t\t mini_thumb:{Text},\n \t\tthumb:{Text}\n } \t\t\n \"fields\": [\n {\n \"id\":{Numeric}\n \"name\":{Text}\n \t...\n },\n ...\n ]\n\t\t...\n}", "language": "json" } ], "sidebar": true } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Definition", "0-0": "id", "0-1": "Numeric", "0-2": "This is a unique identifier associated to each of your groups.", "1-0": "name", "1-1": "Text", "1-2": "This is the group name. limited to 255 chars.", "2-0": "email", "2-1": "Text", "2-2": "This is the group email address. by sending a message to this address users can post directly to the group without the need to login.", "3-0": "parent_group", "3-2": "This is a unique identifier associated with a parent group.", "3-1": "Numeric", "4-0": "logo", "4-1": "Object", "4-2": "The group logo image url", "5-0": "created_at", "5-1": "Numeric", "5-2": "The time this object was created, in UTC milliseconds past the epoch. This field is automatically updated by writing queries and not directly editable.", "6-0": "update_at", "6-1": "Numeric", "6-2": "The time this object was last modified, in UTC milliseconds past the epoch. This field is automatically updated by writing queries and not directly editable.", "7-0": "fields", "7-1": "Array[FieldDefinition]", "7-2": "An array of fields" }, "cols": 3, "rows": 8 } [/block]
{"_id":"55a6108eaaf9cf1900114f0f","link_url":"","sync_unique":"","title":"Get all groups","type":"get","updates":[],"body":"","editedParams":true,"link_external":false,"category":"55a603ce249a40190051d8f7","createdAt":"2015-07-15T07:49:34.794Z","slug":"get-all-groups","user":"55a5d68c80c8a30d00b32498","version":"55a50e92ec735f37000fc6e2","excerpt":"","editedParams2":true,"githubsync":"","hidden":false,"isReference":false,"order":1,"project":"55a50e92ec735f37000fc6df","__v":4,"api":{"examples":{"codes":[{"language":"curl","code":"REQUEST\ncurl 'https://api.mobilize.io/v1/groups?include_fields=true'\n    -X GET\n    -u [API Key]:[API Secret]\n   \t-H 'Accept: application/json'    ","name":""}]},"method":"get","params":[{"name":"include_fields","type":"boolean","default":"false","desc":"Indicates whether or not to include the group fields in the response.","required":false,"in":"path","ref":"","_id":"55a6108eaaf9cf1900114f10"},{"name":"limit","type":"int","default":"","desc":"Sets limit to amount of groups in response.","required":false,"in":"path","ref":"","_id":"5f33fd42615ef00772e61a27"},{"name":"last_group_id","type":"int","default":"","desc":"Last group_id from previous page.","required":false,"in":"path","ref":"","_id":"5f33fe113de6660643cdd0eb"}],"results":{"codes":[{"name":"","code":"{\n  \"groups\": [\n    {\n        \"id\": 1234,\n        \"name\": \"Founders\",\n        \"email\": \"[email protected]\",\n        \"created_at\": 1433233366892,\n        \"updated_at\": 1433233609882,\n        \"parent_group\": null,\n        \"logo\": {\n            \"url\": \"https://s3.amazonaws.com/mobilizestatic/defaultavatars/group2.png\",\n            \"small_thumb\": {\n                \"url\": \"https://s3.amazonaws.com/mobilizestatic/defaultavatars/group2.png\"\n            },\n            \"mini_thumb\": {\n                \"url\": \"https://s3.amazonaws.com/mobilizestatic/defaultavatars/group2.png\"\n            },\n            \"thumb\": {\n                \"url\": \"https://s3.amazonaws.com/mobilizestatic/defaultavatars/group2.png\"\n            }\n        },\n        \"fields\": [\n            {\n                \"required\": true,\n                \"other_option_flag\": true,\n                \"placeholder\": \"\",\n                \"name\": \"First Name\",\n                \"type\": \"text\",\n                \"id\": 1,\n                \"unique_name\": \"first_name\",\n                \"options\": null,\n                \"editable\": true\n            },\n            {\n                \"required\": true,\n                \"other_option_flag\": true,\n                \"placeholder\": \"\",\n                \"name\": \"Last Name\",\n                \"type\": \"text\",\n                \"id\": 2,\n                \"unique_name\": \"last_name\",\n                \"options\": null,               \n                \"editable\": true\n            },\n            {\n                \"required\": true,\n                \"other_option_flag\": true,\n                \"placeholder\": \"\",\n                \"name\": \"Email\",\n                \"type\": \"email\",\n                \"id\": 3,\n                \"unique_name\": \"email\",\n                \"options\": null,\n                \"editable\": true\n            }\n        ],\n      \t\t\"group_url\": \"http://group.mobilize.io/main/groups/4\",\n          \"privacy\": \"private\",\n          \"requires_approval\": true,\n          \"members_posting_permissions\": [\n            \"quickpost\",\n            \"poll\",\n            \"event\",\n            \"fileattachment\"\n          ],\n          \"posts_moderation\": null,\n          \"members_visible\": true,\n          \"email_comments_to_all\": true,\n          \"hidden_emails\": true,\n          \"members_count\": 1,\n          \"default_emails_frequency\": \"IMMEDIATE\"\n    },\n  ...\n\t],\n    \"total_groups\": 14,\n    \"next_page\": \"http://api.mobilize.io/v1/groups?last_group_id=15&limit=50\"\n}\n","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":"/groups?:include_fields","auth":"required"},"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"next":{"description":"","pages":[]},"childrenPages":[]}

getGet all groups


Path Params

include_fields:
booleanfalse
Indicates whether or not to include the group fields in the response.
limit:
integer
Sets limit to amount of groups in response.
last_group_id:
integer
Last group_id from previous page.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"55a6523251457325000e4d24","body":"","editedParams":true,"editedParams2":true,"excerpt":"","link_external":false,"link_url":"","__v":4,"category":"55a603ce249a40190051d8f7","hidden":false,"type":"get","user":"55a5d68c80c8a30d00b32498","createdAt":"2015-07-15T12:29:38.733Z","order":3,"slug":"groupsid","title":"Get a single group","api":{"method":"get","params":[{"name":"group_id","type":"int","default":"","desc":"The unique identifier associated to each of your groups.","required":true,"in":"path","ref":"","_id":"55a6523251457325000e4d25"},{"name":"include_fields","type":"boolean","default":"false","desc":"Indicates whether or not to include the group fields in the response.","required":false,"in":"query","ref":"","_id":"55a7686695bf6d25009a04d7"}],"results":{"codes":[{"status":200,"language":"json","code":"{\t\n  \"id\": 1234,\n  \"name\": \"Founders\",\n  \"email\": \"[email protected]\",\n\t\"created_at\": 1433233366892,\n\t\"updated_at\": 1433233609882,\n\t\"parent_group\": null,\n\t\"logo\": {\n\t\t\"url\": \"https://s3.amazonaws.com/mobilizestatic/defaultavatars/group2.png\",\n\t\t\"small_thumb\": {\n\t\t\t\"url\": \"https://s3.amazonaws.com/mobilizestatic/defaultavatars/group2.png\"\n\t\t},\n\t\t\"mini_thumb\": {\n\t\t\t\"url\": \"https://s3.amazonaws.com/mobilizestatic/defaultavatars/group2.png\"\n\t\t},\n\t\t\"thumb\": {\n\t\t\t\"url\": \"https://s3.amazonaws.com/mobilizestatic/defaultavatars/group2.png\"\n\t\t}\n\t},\n\t\"fields\": [\n\t\t{\n\t\t\t\"required\": true,\n\t\t\t\"other_option_flag\": true,\n\t\t\t\"placeholder\": \"\",\n\t\t\t\"name\": \"First Name\",\n\t\t\t\"type\": \"text\",\n\t\t\t\"id\": 1,\n\t\t\t\"unique_name\": \"first_name\",\n\t\t\t\"options\": null,\n\t\t\t\"editable\": true\n\t\t},\n\t\t{\n\t\t\t\"required\": true,\n\t\t\t\"other_option_flag\": true,\n\t\t\t\"placeholder\": \"\",\n\t\t\t\"name\": \"Last Name\",\n\t\t\t\"type\": \"text\",\n\t\t\t\"id\": 2,\n\t\t\t\"unique_name\": \"last_name\",\n\t\t\t\"options\": null,\n\t\t\t\"editable\": true\n\t\t},\n\t\t{\n\t\t\t\"required\": true,\n\t\t\t\"other_option_flag\": true,\n\t\t\t\"placeholder\": \"\",\n\t\t\t\"name\": \"Email\",\n\t\t\t\"type\": \"email\",\n\t\t\t\"id\": 3,\n\t\t\t\"unique_name\": \"email\",\n\t\t\t\"options\": null,\n\t\t\t\"editable\": true\n\t\t}\n\t],\n  \"group_url\": \"http://group.mobilize.io/main/groups/1234\",\n  \"privacy\": \"public\",\n  \"requires_approval\": false,\n  \"members_posting_permissions\": [\n    \"event\"\n  ],\n  \"posts_moderation\": null,\n  \"members_visible\": false,\n  \"email_comments_to_all\": false,\n  \"hidden_emails\": true,\n  \"members_count\": 1,\n  \"default_emails_frequency\": \"DAILY\"\n}\n   \t","name":""},{"status":500,"language":"text","code":"{\n\t\"error_message\": \"Couldn't find Group with 'id'=123\",\n  \"status_code\": 500\n}"}]},"settings":"","url":"/groups/:group_id","auth":"required","examples":{"codes":[{"language":"curl","code":"REQUEST\ncurl 'https://api.mobilize.io/v1/groups/1234/'\n\t\t\t-X GET\n      -u [API Key]:[API Secret]\n      -H 'Accept: application/json'","name":""}]}},"githubsync":"","project":"55a50e92ec735f37000fc6df","sync_unique":"","updates":[],"version":"55a50e92ec735f37000fc6e2","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"isReference":false,"next":{"description":"","pages":[]},"childrenPages":[]}

getGet a single group


Path Params

group_id:
required
integer
The unique identifier associated to each of your groups.

Query Params

include_fields:
booleanfalse
Indicates whether or not to include the group fields in the response.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5f02f6edba880200748936d5","metadata":{"image":[],"title":"","description":""},"api":{"url":"/groups","auth":"required","examples":{"codes":[{"language":"curl","code":"REQUEST\ncurl 'https://api.mobilize.io/v1/groups'\n    -X POST\n    -u [API Key]:[API Secret]\n    -H 'Content-Type: application/json'\n    -H 'Accept: application/json'\n    -d '{\n            \"name\": \"9\",\n            \"parent_group_id\": \"1\",\n            \"privacy\": \"5\",\n            \"invite_members_enabled\": \"false\",\n            \"hidden_emails\": \"\",\n            \"alias_name\": \"group_name_9\",\n            \"default_emails_frequency\": \"0\",\n            \"manager_email_address\": \"[email protected]\"\n        }'","name":""}]},"method":"post","params":[{"name":"name","type":"string","default":"","desc":"Name of new group.","required":true,"in":"body","ref":"","_id":"55acfdf1fb7b3c1900373a2d"},{"name":"parent_group_id","type":"int","default":"","desc":"ID of parent group.","required":true,"in":"body","ref":"","_id":"55ad53f924cf160d00135889"},{"name":"privacy","type":"int","default":"","desc":"Status of new group, accepted values: 5 - open group, 10 - closed group","required":true,"in":"body","ref":"","_id":"5f02f6edba880200748936db"},{"name":"invite_members_enabled","type":"boolean","default":"","desc":"Could members invite others to group.","required":true,"in":"body","ref":"","_id":"5f02f6edba880200748936da"},{"name":"hidden_emails","type":"boolean","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5f02f6edba880200748936d9"},{"name":"alias_name","type":"string","default":"","desc":"Prefix of new groups email.","required":true,"in":"body","ref":"","_id":"5f02f6edba880200748936d8"},{"name":"default_emails_frequency","type":"string","default":"","desc":"Accepted values: 0 - immediate notification, 1 - daily notification, 9 - disabled notifications.","required":true,"in":"body","ref":"","_id":"5f02f6edba880200748936d7"},{"name":"manager_email_address","type":"string","default":"","desc":"Email of user that would be group manager. Should be registered in the system and at least member of your current group.","required":true,"in":"body","ref":"","_id":"5f02f6edba880200748936d6"}],"results":{"codes":[{"language":"json","code":"{\n\t  \"id\": 15,\n  \t\"name\": \"9\",\n    \"email\": \"[email protected]\",\n    \"created_at\": 1594029581437,\n    \"updated_at\": 1594029581614,\n    \"parent_group\": 1,\n    \"logo\": {\n        \"url\": \"https://d14dzjqszgfb6.cloudfront.net/defaultavatars/[email protected]\",\n        \"thumb\": {\n            \"url\": \"https://d14dzjqszgfb6.cloudfront.net/defaultavatars/[email protected]\"\n        },\n        \"small_thumb\": {\n            \"url\": \"https://d14dzjqszgfb6.cloudfront.net/defaultavatars/[email protected]\"\n        },\n        \"mini_thumb\": {\n            \"url\": \"https://d14dzjqszgfb6.cloudfront.net/defaultavatars/[email protected]\"\n        }\n    },\n    \"fields\": [\n        {\n            \"id\": 1,\n            \"name\": \"First Name\",\n            \"type\": \"text\",\n            \"unique_name\": \"first_name\",\n            \"options\": null,\n            \"other_option_flag\": false,\n            \"placeholder\": null,\n            \"required\": true\n        },\n        {\n            \"id\": 2,\n            \"name\": \"Last Name\",\n            \"type\": \"text\",\n            \"unique_name\": \"last_name\",\n            \"options\": null,\n            \"other_option_flag\": false,\n            \"placeholder\": null,\n            \"required\": true\n        },\n        {\n            \"id\": 3,\n            \"name\": \"Email\",\n            \"type\": \"email\",\n            \"unique_name\": \"email\",\n            \"options\": null,\n            \"other_option_flag\": false,\n            \"placeholder\": null,\n            \"required\": true\n        },\n        {\n            \"id\": 7,\n            \"name\": \"Job Title\",\n            \"type\": \"text\",\n            \"unique_name\": \"job_title\",\n            \"options\": null,\n            \"other_option_flag\": false,\n            \"placeholder\": null,\n            \"required\": false\n        },\n        {\n            \"id\": 11,\n            \"name\": \"Company Name\",\n            \"type\": \"text\",\n            \"unique_name\": \"company_name\",\n            \"options\": null,\n            \"other_option_flag\": false,\n            \"placeholder\": null,\n            \"required\": false\n        }\n    ],\n    \"group_url\": \"http://tester.mobilize.io/main/groups/15\",\n    \"privacy\": \"public\",\n    \"requires_approval\": false,\n    \"members_posting_permissions\": [\n        \"quickpost\",\n        \"poll\",\n        \"event\",\n        \"fileattachment\"\n    ],\n    \"posts_moderation\": null,\n    \"members_visible\": true,\n    \"email_comments_to_all\": true,\n    \"hidden_emails\": null,\n    \"members_count\": 1,\n    \"default_emails_frequency\": \"IMMEDIATE\"\n}","name":"","status":200},{"code":"{    \n  \"error_message\": \"This group name already exists in your network.\",\n  \"status_code\": 400\n}","name":"","status":400,"language":"json"}]},"settings":""},"next":{"description":"","pages":[]},"title":"Create single group","type":"post","slug":"create-group","excerpt":"","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If the user id is not supplied, the user will be created automatically for convenience reasons. Make sure you include the email in the fields hash.\\n\\nFor adding an existing user to a group, add user_id param to the root of your JSON request.\",\n  \"title\": \"\"\n}\n[/block]","updates":[],"order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2020-07-06T10:03:25.897Z","user":"5f02e7c83c7f2200254827a3","category":"55a603ce249a40190051d8f7","version":"55a50e92ec735f37000fc6e2","project":"55a50e92ec735f37000fc6df","__v":3,"parentDoc":null,"childrenPages":[]}

postCreate single group


Body Params

name:
required
string
Name of new group.
parent_group_id:
required
integer
ID of parent group.
privacy:
required
integer
Status of new group, accepted values: 5 - open group, 10 - closed group
invite_members_enabled:
required
boolean
Could members invite others to group.
hidden_emails:
required
boolean
alias_name:
required
string
Prefix of new groups email.
default_emails_frequency:
required
string
Accepted values: 0 - immediate notification, 1 - daily notification, 9 - disabled notifications.
manager_email_address:
required
string
Email of user that would be group manager. Should be registered in the system and at least member of your current group.
[block:callout] { "type": "info", "body": "If the user id is not supplied, the user will be created automatically for convenience reasons. Make sure you include the email in the fields hash.\n\nFor adding an existing user to a group, add user_id param to the root of your JSON request.", "title": "" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "body": "If the user id is not supplied, the user will be created automatically for convenience reasons. Make sure you include the email in the fields hash.\n\nFor adding an existing user to a group, add user_id param to the root of your JSON request.", "title": "" } [/block]
{"_id":"5f030218beee84002f05c8ff","metadata":{"image":[],"title":"","description":""},"api":{"url":"/groups/:id","auth":"required","examples":{"codes":[{"language":"curl","code":"REQUEST\ncurl 'https://api.mobilize.io/v1/groups/1234'\n    -X POST\n    -u [API Key]:[API Secret]\n    -H 'Content-Type: application/json'\n    -H 'Accept: application/json'\n    -d '{\n    \t\t\t\"name\": \"new_group_name\",\n          \"privacy\": 5,\n          \"invite_members_enabled\": true,\n          \"members_visible\": false,\n          \"requires_approval\": true,\n          \"hidden_emails\": false,\n          \"alias_name\": \"new_alias_name\",\n          \"default_emails_frequency\": 1\n        }'","name":""}]},"method":"put","params":[{"name":"id","type":"int","default":"","desc":"The unique identifier associated to each of your groups.","required":true,"in":"path","ref":"","_id":"5f030218beee84002f05c909"},{"name":"name","type":"string","default":"","desc":"New name of group.","required":false,"in":"body","ref":"","_id":"55acfdf1fb7b3c1900373a2d"},{"name":"privacy","type":"int","default":"","desc":"Status of new group, accepted values: 5 - open group, 10 - closed group","required":false,"in":"body","ref":"","_id":"5f02f6edba880200748936db"},{"name":"invite_members_enabled","type":"boolean","default":"","desc":"Could members invite others to group.","required":false,"in":"body","ref":"","_id":"5f02f6edba880200748936da"},{"name":"members_posting_permissions","type":"array_object","default":"","desc":"Array of post types that are allowed for posting in group.   EX: quickpost, poll, event, opportunity, recommendation, fileattachment","required":false,"in":"body","ref":"","_id":"5f030218beee84002f05c905"},{"name":"members_visible","type":"boolean","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5f030218beee84002f05c904"},{"name":"requires_approval","type":"boolean","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5f030218beee84002f05c903"},{"name":"hidden_emails","type":"boolean","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5f02f6edba880200748936d9"},{"name":"alias_name","type":"string","default":"","desc":"Prefix of new groups email.","required":false,"in":"body","ref":"","_id":"5f02f6edba880200748936d8"},{"name":"default_emails_frequency","type":"string","default":"","desc":"Accepted values: 0 - immediate notification, 1 - daily notification, 9 - disabled notifications.","required":false,"in":"body","ref":"","_id":"5f02f6edba880200748936d7"}],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":""},"next":{"description":"","pages":[]},"title":"Update single group","type":"put","slug":"update-single-group","excerpt":"","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If the user id is not supplied, the user will be created automatically for convenience reasons. Make sure you include the email in the fields hash.\\n\\nFor adding an existing user to a group, add user_id param to the root of your JSON request.\",\n  \"title\": \"\"\n}\n[/block]","updates":[],"order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2020-07-06T10:51:04.171Z","user":"5f02e7c83c7f2200254827a3","category":"55a603ce249a40190051d8f7","version":"55a50e92ec735f37000fc6e2","project":"55a50e92ec735f37000fc6df","__v":2,"parentDoc":null,"childrenPages":[]}

putUpdate single group


Path Params

id:
required
integer
The unique identifier associated to each of your groups.

Body Params

name:
string
New name of group.
privacy:
integer
Status of new group, accepted values: 5 - open group, 10 - closed group
invite_members_enabled:
boolean
Could members invite others to group.
members_posting_permissions:
array of objects
Array of post types that are allowed for posting in group. EX: quickpost, poll, event, opportunity, recommendation, fileattachment
members_visible:
boolean
requires_approval:
boolean
hidden_emails:
boolean
alias_name:
string
Prefix of new groups email.
default_emails_frequency:
string
Accepted values: 0 - immediate notification, 1 - daily notification, 9 - disabled notifications.
[block:callout] { "type": "info", "body": "If the user id is not supplied, the user will be created automatically for convenience reasons. Make sure you include the email in the fields hash.\n\nFor adding an existing user to a group, add user_id param to the root of your JSON request.", "title": "" } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "body": "If the user id is not supplied, the user will be created automatically for convenience reasons. Make sure you include the email in the fields hash.\n\nFor adding an existing user to a group, add user_id param to the root of your JSON request.", "title": "" } [/block]
{"_id":"5f030b70d4dab50020a5597c","metadata":{"image":[],"title":"","description":""},"api":{"url":"/bulk/groups","auth":"required","settings":"","results":{"codes":[{"language":"json","code":"{\n    \"job_id\": \"a610e765dc0b7cc48a452157\",\n    \"status\": \"queued\"\n}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"method":"post","examples":{"codes":[{"language":"curl","code":"REQUEST\ncurl 'https://api.mobilize.io/v1/bulk/groups'\n    -X POST\n    -u [API Key]:[API Secret]\n    -H 'Content-Type: application/json'\n    -H 'Accept: application/json'\n    -d '{     \n          \"groups\": [\n        \t\t{\n              \"name\": \"name_123\",\n              \"parent_group_id\": 1,\n              \"privacy\": 5,\n              \"alias_name\": \"group-123,\n              \"create_posts_enabled\": true,\n              \"invite_members_enabled\": false,\n              \"create_subgroups_enabled\": false,\n              \"members_visible\": true,\n              \"email_comments_to_all\": true,\n              \"hidden_emails\": true,\n              \"members_posting_permissions\": [\"QuickPost\", \"Poll\", \"Event\", \"FileAttachment\"],\n              \"requires_approval\": true,\n              \"public_form\": true,\n              \"default_emails_frequency\": 1,\n              \"manager_email_address\": \"[email protected]\"\n       \t\t },\n       \t\t {\n              \"name\": \"name_124\",\n              \"privacy\": 10,\n              \"parent_group_id\": 1,\n              \"alias_name\": \"group-124\",\n              \"create_posts_enabled\": true,\n              \"invite_members_enabled\": false,\n              \"create_subgroups_enabled\": false,\n              \"members_visible\": true,\n              \"email_comments_to_all\": true,\n              \"hidden_emails\": true,\n              \"members_posting_permissions\": [\"QuickPost\", \"Poll\", \"Event\"],\n              \"requires_approval\": true,\n              \"public_form\": true,\n              \"default_emails_frequency\": 0,\n              \"manager_email_address\": \"[email protected]\"\n           }\n    \t\t]\n      }'","name":""}]},"params":[{"name":"groups","type":"array_object","default":"","desc":"An array of groups containing fields","required":false,"in":"body","ref":"","_id":"55acfdf1fb7b3c1900373a2d"}]},"next":{"description":"","pages":[]},"title":"Create groups in bulk","type":"post","slug":"create-groups-in-bulk","excerpt":"This api allows you to create members in bulk. \nThe response will return job_id that you will be able to query using the Get bulk import status api.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Make sure you include the email in the fields hash.\\nIf the users already exist it will overwrite the data with the data provided in the api body.\\n\\nImportant: The limit for each bulk is 1000 members, and you can only use one bulk api at a time.\",\n  \"title\": \"\"\n}\n[/block]","updates":[],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2020-07-06T11:30:56.676Z","user":"5f02e7c83c7f2200254827a3","category":"55a603ce249a40190051d8f7","version":"55a50e92ec735f37000fc6e2","project":"55a50e92ec735f37000fc6df","__v":2,"parentDoc":null,"childrenPages":[]}

postCreate groups in bulk

This api allows you to create members in bulk. The response will return job_id that you will be able to query using the Get bulk import status api.

Body Params

groups:
array of objects
An array of groups containing fields
[block:callout] { "type": "info", "body": "Make sure you include the email in the fields hash.\nIf the users already exist it will overwrite the data with the data provided in the api body.\n\nImportant: The limit for each bulk is 1000 members, and you can only use one bulk api at a time.", "title": "" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "body": "Make sure you include the email in the fields hash.\nIf the users already exist it will overwrite the data with the data provided in the api body.\n\nImportant: The limit for each bulk is 1000 members, and you can only use one bulk api at a time.", "title": "" } [/block]
{"_id":"5f030be5a1e949001efca95c","metadata":{"image":[],"title":"","description":""},"api":{"url":"/bulk/groups","auth":"required","settings":"","results":{"codes":[{"language":"json","code":"{\n    \"job_id\": \"a610e765dc0b7cc48a452157\",\n    \"status\": \"queued\"\n}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"method":"put","examples":{"codes":[{"language":"curl","code":"REQUEST\ncurl 'https://api.mobilize.io/v1/bulk/groups'\n    -X POST\n    -u [API Key]:[API Secret]\n    -H 'Content-Type: application/json'\n    -H 'Accept: application/json'\n    -d '{     \n          \"groups\": [\n        \t\t{\n                \"id\": 3,\n                \"name\": \"name_333\",\n                \"privacy\": 5,\n                \"alias_name\": \"group-333\",\n                \"create_posts_enabled\": true,\n                \"invite_members_enabled\": false,\n                \"create_subgroups_enabled\": false,\n                \"members_visible\": true,\n                \"email_comments_to_all\": true,\n                \"hidden_emails\": true,\n                \"members_posting_permissions\": [\"QuickPost\", \"Poll\", \"Event\", \"FileAttachment\"],\n                \"requires_approval\": true,\n                \"public_form\": true,\n                \"default_emails_frequency\": 1\n            },\n            {\n                \"id\": 4,\n                \"name\": \"name_222\",\n                \"privacy\": 10,\n                \"alias_name\": \"group-222\",\n                \"create_posts_enabled\": true,\n                \"invite_members_enabled\": false,\n                \"create_subgroups_enabled\": false,\n                \"members_visible\": true,\n                \"email_comments_to_all\": true,\n                \"hidden_emails\": true,\n                \"members_posting_permissions\": [\"QuickPost\", \"Poll\", \"Event\"],\n                \"requires_approval\": true,\n                \"public_form\": true,\n                \"default_emails_frequency\": 0\n            }\n        \t]\n      \t}'","name":""}]},"params":[{"name":"groups","type":"array_object","default":"","desc":"An array of groups containing fields","required":false,"in":"body","ref":"","_id":"55acfdf1fb7b3c1900373a2d"}]},"next":{"description":"","pages":[]},"title":"Update groups in bulk","type":"put","slug":"update-groups-in-bulk","excerpt":"This api allows you to create members in bulk. \nThe response will return job_id that you will be able to query using the Get bulk import status api.","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Make sure you include the email in the fields hash.\\nIf the users already exist it will overwrite the data with the data provided in the api body.\\n\\nImportant: The limit for each bulk is 1000 members, and you can only use one bulk api at a time.\",\n  \"title\": \"\"\n}\n[/block]","updates":[],"order":7,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2020-07-06T11:32:53.163Z","user":"5f02e7c83c7f2200254827a3","category":"55a603ce249a40190051d8f7","version":"55a50e92ec735f37000fc6e2","project":"55a50e92ec735f37000fc6df","__v":1,"parentDoc":null,"childrenPages":[]}

putUpdate groups in bulk

This api allows you to create members in bulk. The response will return job_id that you will be able to query using the Get bulk import status api.

Body Params

groups:
array of objects
An array of groups containing fields
[block:callout] { "type": "info", "body": "Make sure you include the email in the fields hash.\nIf the users already exist it will overwrite the data with the data provided in the api body.\n\nImportant: The limit for each bulk is 1000 members, and you can only use one bulk api at a time.", "title": "" } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "body": "Make sure you include the email in the fields hash.\nIf the users already exist it will overwrite the data with the data provided in the api body.\n\nImportant: The limit for each bulk is 1000 members, and you can only use one bulk api at a time.", "title": "" } [/block]
{"_id":"55aced3218eefd0d0071d5ec","link_url":"","title":"Get group member","type":"get","version":"55a50e92ec735f37000fc6e2","api":{"url":"/groups/:group_id/members/:user_id/","auth":"required","examples":{"codes":[{"language":"curl","code":"REQUEST\ncurl 'https://api.mobilize.io/v1/groups/12354/members/1234'\n\t\t\t-X GET\n      -u [API Key]:[API Secret]\n      -H 'Accept: application/json'","name":""}]},"method":"get","params":[{"_id":"55aced3218eefd0d0071d5ee","required":true,"desc":"The unique identifier associated to each of your groups.","default":"","type":"int","name":"group_id","in":"path"},{"required":true,"desc":"The unique identifier associated to each of your users.","default":"","type":"int","name":"user_id","in":"path","_id":"55aced3218eefd0d0071d5ed"},{"desc":"Indicates whether or not to include the group fields in the response.","name":"include_fields","required":false,"type":"boolean","in":"query","_id":"55acf72efb7b3c1900373a15","default":"false"}],"results":{"codes":[{"name":"","code":"{\n \t\"id\": \"1234\",\n \t\"name\": \"Sam Cooper\",\n \t\"first_name\": \"Sam\",\n \t\"last_name\": \"Cooper\",\n \t\"email\": \"[email protected]\",\n \t\"updated_at\": 1433233515826,\n \t\"created_at\": 1433233515826,\n \t\"is_registered\": true,  \n \t\"groups\": [\n\t\t{\n\t   \"id\": 12354,\n\t   \"is_admin\": false,\n\t   \"last_invited_in\": 1433869292669\n\t\t}\n \t],\n \t\"avatar\": {\n\t\t\"image\": \"URL to sam's original image\",\n\t\t\"small_thumb\": \"URL to sam's original image 80x80 px\",\n\t\t\"mini_thumb\": \"URL to sam's original image 30x30 px\",\n\t\t\"thumb\": \"URL to sam's original image 280x280 px\"\n },\n \"fields\": {\n\t\t\t....\n\t}  \n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":""},"excerpt":"","order":8,"editedParams2":true,"slug":"get-group-member","__v":1,"link_external":false,"createdAt":"2015-07-20T12:44:34.905Z","editedParams":true,"githubsync":"","hidden":false,"project":"55a50e92ec735f37000fc6df","sync_unique":"","body":"","category":"55a603ce249a40190051d8f7","updates":[],"user":"55a5d68c80c8a30d00b32498","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getGet group member


Path Params

group_id:
required
integer
The unique identifier associated to each of your groups.
user_id:
required
integer
The unique identifier associated to each of your users.

Query Params

include_fields:
booleanfalse
Indicates whether or not to include the group fields in the response.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"55acece5f93f0c0d005b8813","editedParams2":true,"githubsync":"","link_external":false,"sync_unique":"","body":"","isReference":false,"link_url":"","title":"Get group members","excerpt":"","createdAt":"2015-07-20T12:43:17.049Z","order":9,"slug":"get-group-members","updates":[],"category":"55a603ce249a40190051d8f7","api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"REQUEST\ncurl 'https://api.mobilize.io/v1/groups/12354/members/?include_fields=true&offset=0&limit=50'\n\t\t\t-X GET\n      -u [API Key]:[API Secret]\n      -H 'Accept: application/json'","name":""}]},"method":"get","params":[{"default":"","type":"int","name":"group_id","in":"path","_id":"55acece5f93f0c0d005b8814","ref":"","required":true,"desc":"The unique identifier associated to each of your groups."},{"in":"path","_id":"55acf773f93f0c0d005b8831","ref":"","required":false,"desc":"Indicates whether or not to include the group fields in the response.","default":"false","type":"boolean","name":"include_fields"},{"name":"offset","in":"path","_id":"56e6611352d2f60e00a80044","ref":"","required":false,"desc":"The offset from the beginning of the list of members that returns from the query.","default":"0","type":"int"},{"default":"50","type":"int","name":"limit","in":"path","_id":"56e6611352d2f60e00a80043","ref":"","required":false,"desc":"The maximum number of members the query will return."}],"results":{"codes":[{"language":"json","code":"[\n   {\n     \"id\": \"1234\",\n     \"name\": \"Sam Cooper\",\n     \"first_name\": \"Sam\",\n     \"last_name\": \"Cooper\",\n     \"email\": \"[email protected]\",\n     \"updated_at\": 1433233515826,\n     \"created_at\": 1433233515826,\n     \"is_registered\": true,  \n     \"groups\": [\n        {\n           \"id\": 12354,\n           \"is_admin\": false,\n           \"last_invited_in\": 1433869292669\n     \t\t}\n     ],\n     \"avatar\": {\n       \t\"image\": \"URL to sam's original image\",\n\t\t\t\t\"small_thumb\": \"URL to sam's original image 80x80 px\",\n\t\t\t\t\"mini_thumb\": \"URL to sam's original image 30x30 px\",\n\t\t\t\t\"thumb\": \"URL to sam's original image 280x280 px\"\n     },\n     \"fields\": {\n\t\t\t\t....\n     \t\t}     \n     },\n   ...\n]","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"/groups/:group_id/members/?:include_fields&:offset&:limit"},"editedParams":true,"hidden":false,"project":"55a50e92ec735f37000fc6df","type":"get","user":"55a5d68c80c8a30d00b32498","__v":3,"version":"55a50e92ec735f37000fc6e2","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getGet group members


Path Params

group_id:
required
integer
The unique identifier associated to each of your groups.
include_fields:
booleanfalse
Indicates whether or not to include the group fields in the response.
offset:
integer0
The offset from the beginning of the list of members that returns from the query.
limit:
integer50
The maximum number of members the query will return.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"55aced6b18eefd0d0071d5ef","createdAt":"2015-07-20T12:45:31.613Z","githubsync":"","hidden":false,"type":"post","version":"55a50e92ec735f37000fc6e2","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If the user id is not supplied, the user will be created automatically for convenience reasons. Make sure you include the email in the fields hash.\\n\\nFor adding an existing user to a group, add user_id param to the root of your JSON request.\",\n  \"title\": \"\"\n}\n[/block]","category":"55a603ce249a40190051d8f7","editedParams":true,"editedParams2":true,"link_url":"","sync_unique":"","__v":2,"api":{"auth":"required","examples":{"codes":[{"language":"curl","code":"REQUEST\ncurl 'https://api.mobilize.io/v1/groups/12354/members'\n    -X POST\n    -u [API Key]:[API Secret]\n    -H 'Content-Type: application/json'\n    -H 'Accept: application/json'\n    -d '{     \n    \t\t\t\"user_id\":1234 #Optional\n          \"fields\":{\n            \"email\":\"[email protected]\",        \t\n            \"first_name\":\"Sam\",\n            \"last_name\":\"Cooper\",\n            \"facebook_url\":\"https://www.facebook.com/path_to_sam_url\"\n          }\n    \t\t}'","name":""}]},"method":"post","params":[{"default":"","type":"int","name":"group_id","in":"path","_id":"55aced6b18eefd0d0071d5f0","required":true,"desc":"The unique identifier associated to each of your groups."},{"in":"body","_id":"55acfdf1fb7b3c1900373a2d","default":"","desc":"The unique identifier associated to each of your users.","name":"user_id","required":false,"type":"int"},{"required":false,"type":"object","in":"body","_id":"55ad53f924cf160d00135889","default":"","desc":"Key value object, key - field unique name, value - field valid value","name":"fields"}],"results":{"codes":[{"language":"json","code":"{\n\t \"id\": \"1234\",\n\t \"name\": \"Sam Cooper\",\n\t \"first_name\": \"Sam\",\n\t \"last_name\": \"Cooper\",\n\t \"email\": \"[email protected]\",\n\t \"updated_at\": 1433233515826,\n\t \"created_at\": 1433233515826,\n\t \"is_registered\": true,  \n\t \"groups\": [\n\t\t{\n\t\t   \"id\": 12354,\n\t\t   \"is_admin\": false,\n\t\t   \"last_invited_in\": 1433869292669\n\t\t\t}\n\t ],\n\t \"avatar\": {\n\t\t\t\"image\": \"URL to sam's original image\",\n\t\t\t\"small_thumb\": \"URL to sam's original image 80x80 px\",\n\t\t\t\"mini_thumb\": \"URL to sam's original image 30x30 px\",\n\t\t\t\"thumb\": \"URL to sam's original image 280x280 px\"\n\t },\n\t \"fields\": {\n\t\t\t\t  \"first_name\":\"Sam\",\n          \"last_name\":\"Cooper\",     \t\t\t\n          \"facebook_url\":\"https://www.facebook.com/path_to_sam_url\",\n     \t\t\t\"email\":\"[email protected]\"\n\t\t\t} \n}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"/groups/:group_id/members/"},"excerpt":"","link_external":false,"order":10,"slug":"create-group-member","title":"Create group member","project":"55a50e92ec735f37000fc6df","updates":[],"user":"55a5d68c80c8a30d00b32498","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postCreate group member


Path Params

group_id:
required
integer
The unique identifier associated to each of your groups.

Body Params

user_id:
integer
The unique identifier associated to each of your users.
fields:
object
Key value object, key - field unique name, value - field valid value
[block:callout] { "type": "info", "body": "If the user id is not supplied, the user will be created automatically for convenience reasons. Make sure you include the email in the fields hash.\n\nFor adding an existing user to a group, add user_id param to the root of your JSON request.", "title": "" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "body": "If the user id is not supplied, the user will be created automatically for convenience reasons. Make sure you include the email in the fields hash.\n\nFor adding an existing user to a group, add user_id param to the root of your JSON request.", "title": "" } [/block]
{"_id":"55aceda218eefd0d0071d5f2","editedParams2":true,"link_url":"","type":"put","updates":[],"user":"55a5d68c80c8a30d00b32498","version":"55a50e92ec735f37000fc6e2","api":{"examples":{"codes":[{"name":"","code":"REQUEST\ncurl 'https://api.mobilize.io/v1/groups/12354/members/1234/'\n    -X PUT\n    -u [API Key]:[API Secret]\n    -H 'Content-Type: application/json'\n    -H 'Accept: application/json'\n    -d '{     \t\t\t\n          \"fields\":{\n            \"facebook_url\":\"https://www.facebook.com/some_other_url\"\n          }\n    \t\t}'","language":"curl"}]},"method":"put","params":[{"name":"group_id","in":"path","_id":"55aceda218eefd0d0071d5f4","required":true,"desc":"The unique identifier associated to each of your groups.","default":"","type":"int"},{"name":"user_id","in":"path","_id":"55aceda218eefd0d0071d5f3","required":true,"desc":"The unique identifier associated to each of your users.","default":"","type":"int"},{"desc":"Key value object, key - field unique name, value - field valid value","name":"fields","required":true,"type":"object","in":"body","_id":"55ae012b8576b92300291c2a","default":""}],"results":{"codes":[{"status":200,"language":"json","code":"{\n\t \"id\": \"1234\",\n\t \"name\": \"Sam Cooper\",\n\t \"first_name\": \"Sam\",\n\t \"last_name\": \"Cooper\",\n\t \"email\": \"[email protected]\",\n\t \"updated_at\": 1433233515826,\n\t \"created_at\": 1433233515826,\n\t \"is_registered\": true,  \n\t \"groups\": [\n\t\t{\n\t\t   \"id\": 12354,\n\t\t   \"is_admin\": false,\n\t\t   \"last_invited_in\": 1433869292669\n\t\t\t}\n\t ],\n\t \"avatar\": {\n\t\t\t\"image\": \"URL to sam's original image\",\n\t\t  \"small_thumb\": \"URL to sam's original image 80x80 px\",\n\t\t  \"mini_thumb\": \"URL to sam's original image 30x30 px\",\n\t\t  \"thumb\": \"URL to sam's original image 280x280 px\"\n\t },\n\t \"fields\": {\n      \t\"first_name\":\"Sam\",\n        \"last_name\":\"Cooper\",     \t\t\t\n     \t\t\"email\":\"[email protected]\",\n\t\t\t\t\"facebook_url\":\"https://www.facebook.com/some_other_url\"\n\t\t\t} \n}","name":""},{"status":400,"language":"json","code":"{\n  \"error_code\":404,\n  \"error_message\":\"User id is missing, please validate your request.\"\n}","name":""}]},"settings":"","url":"/groups/:group_id/members/:user_id","auth":"required"},"createdAt":"2015-07-20T12:46:26.636Z","githubsync":"","hidden":false,"project":"55a50e92ec735f37000fc6df","__v":1,"body":"","link_external":false,"sync_unique":"","category":"55a603ce249a40190051d8f7","editedParams":true,"slug":"update-group-member","title":"Update group member","excerpt":"","order":11,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

putUpdate group member


Path Params

group_id:
required
integer
The unique identifier associated to each of your groups.
user_id:
required
integer
The unique identifier associated to each of your users.

Body Params

fields:
required
object
Key value object, key - field unique name, value - field valid value

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"55acede7f93f0c0d005b8817","user":"55a5d68c80c8a30d00b32498","body":"","sync_unique":"","type":"delete","slug":"delete-group-member","updates":[],"__v":1,"api":{"examples":{"codes":[{"name":"","code":"REQUEST\ncurl 'https://api.mobilize.io/v1/groups/12354/members/1234/\n    -X DELETE\n    -u [API Key]:[API Secret]\n    -H 'Accept: application/json'","language":"curl"}]},"method":"delete","params":[{"_id":"55acede7f93f0c0d005b8819","ref":"","in":"path","required":true,"desc":"The unique identifier associated to each of your groups.","default":"","type":"int","name":"group_id"},{"_id":"55acede7f93f0c0d005b8818","ref":"","in":"path","required":true,"desc":"The unique identifier associated to each of your users.","default":"","type":"int","name":"user_id"},{"_id":"5b0552575f9a0d00039a804f","ref":"","in":"path","required":false,"desc":"Indicates whether or not to delete all the content the user created within the group","default":"false","type":"boolean","name":"hard_delete"}],"results":{"codes":[{"language":"json","status":200,"name":"","code":"{ \"success\":true }"},{"status":404,"name":"","code":"{\n  error_code:404,\n \"error_message\":\"User id(user_id) is not exist.\"\n}","language":"json"},{"language":"json","status":400,"code":"{\n  \"error_code\":404,\n  \"error_message\":\"User id is missing, please validate your request.\"\n}"}]},"settings":"","url":"/groups/:group_id/members/:user_id/","auth":"required"},"link_external":false,"excerpt":"","link_url":"","order":12,"project":"55a50e92ec735f37000fc6df","category":"55a603ce249a40190051d8f7","createdAt":"2015-07-20T12:47:35.174Z","editedParams":true,"hidden":false,"title":"Delete group member","version":"55a50e92ec735f37000fc6e2","editedParams2":true,"githubsync":"","isReference":false,"next":{"description":"","pages":[]},"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

deleteDelete group member


Path Params

group_id:
required
integer
The unique identifier associated to each of your groups.
user_id:
required
integer
The unique identifier associated to each of your users.
hard_delete:
booleanfalse
Indicates whether or not to delete all the content the user created within the group

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"569eb27ad233620d007055e4","project":"55a50e92ec735f37000fc6df","type":"get","version":"55a50e92ec735f37000fc6e2","hidden":false,"createdAt":"2016-01-19T22:02:34.658Z","excerpt":"On the Mobilize platform, users are able to search for group members based on the metadata in the fields.\nAs this is a powerful feature, we have also enabled this capability for our API users.","order":13,"user":"55a50dd1750a9a23005332c6","__v":3,"category":"55a603ce249a40190051d8f7","editedParams":true,"link_external":false,"slug":"search-for-group-members","sync_unique":"","title":"Search for group members","updates":[],"api":{"settings":"","url":"/groups/:group_id/members/search?:keywords&:limit&:offset&:include_fields","auth":"required","examples":{"codes":[{"language":"curl","code":"REQUEST\ncurl 'https://api.mobilize.io/v1/groups/1431/members/search?keywords=sam_cooper%40domain.com'\n    -X GET\n    -u [API Key]:[API Secret]\n    -H 'Accept: application/json'"}]},"method":"get","params":[{"name":"keywords","required":true,"type":"string","in":"path","_id":"569eb2d1c9b43e0d00c4bafc","default":"","desc":"URI Generic Syntax by rfc2396 definition"},{"required":false,"desc":"The offset from the beginning of the list of users that returns from the query.","default":"0","type":"int","name":"offset","in":"path","_id":"569eb34cfbee990d0072d978"},{"name":"limit","in":"path","_id":"569eb34cfbee990d0072d977","required":false,"desc":"The maximum number of users the query will return. Test in the API Explorer","default":"50","type":"int"},{"name":"include_fields","in":"path","_id":"569eb34cfbee990d0072d976","required":false,"desc":"Indicates whether or not to include the group fields in the response.","default":"false","type":"boolean"}],"results":{"codes":[{"name":"","code":"[\n   {\n     \"id\": \"1234\",\n     \"name\": \"Sam Cooper\",\n     \"first_name\": \"Sam\",\n     \"last_name\": \"Cooper\",\n     \"email\": \"[email protected]\",\n     \"updated_at\": 1433233515826,\n     \"created_at\": 1433233515826,\n     \"is_registered\": true,  \n     \"groups\": [\n        {\n           \"id\": 1431,\n           \"is_admin\": false,\n           \"last_invited_in\": 1433869292669\n        }\n     ],\n     \"avatar\": {\n        \"image\": \"URL to sam's original image\",\n        \"small_thumb\": \"URL to sam's original image 80x80 px\",\n        \"mini_thumb\": \"URL to sam's original image 30x30 px\",\n        \"thumb\": \"URL to sam's original image 280x280 px\"\n     },\n     \"fields\": {\n        ....\n     }     \n  },\n   ...\n]","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"body":"","editedParams2":true,"githubsync":"","link_url":"","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getSearch for group members

On the Mobilize platform, users are able to search for group members based on the metadata in the fields. As this is a powerful feature, we have also enabled this capability for our API users.

Path Params

keywords:
required
string
URI Generic Syntax by rfc2396 definition
offset:
integer0
The offset from the beginning of the list of users that returns from the query.
limit:
integer50
The maximum number of users the query will return. Test in the API Explorer
include_fields:
booleanfalse
Indicates whether or not to include the group fields in the response.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"569eb46cffccd10d00a05c93","user":"55a50dd1750a9a23005332c6","link_external":false,"project":"55a50e92ec735f37000fc6df","editedParams2":true,"githubsync":"","slug":"invite-group-members","sync_unique":"","createdAt":"2016-01-19T22:10:52.890Z","editedParams":true,"type":"post","isReference":false,"link_url":"","api":{"examples":{"codes":[{"code":"REQUEST\ncurl 'https://api.mobilize.io/v1/groups/12354/members/invite/'\n    -X POST\n    -u [API Key]:[API Secret]\n    -H 'Content-Type: application/json'\n    -H 'Accept: application/json'\n    -d '{         \n          \"sender_id\":42345,\n          \"recipients_ids\":[54321,98765]\n    \t\t}'","language":"curl"}]},"method":"post","params":[{"name":"sender_id","type":"string","default":"","desc":"An authorized group members user id which will be presented as the email sender.","required":true,"in":"body","ref":"","_id":"569eb750c237d225002df5df"},{"name":"recipients_ids","type":"array_int","default":"","desc":"Group members user ids. (limited to 500 users on each request)","required":true,"in":"body","ref":"","_id":"569eb750c237d225002df5de"}],"results":{"codes":[{"status":200,"language":"json","code":"{success:true}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/groups/:group_id/members/invite","auth":"required"},"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Note that the invitation service is an ​asynchronous​ service.\\nAll the invitation requests are queued on ​the Mobilize platform and will be executed by our priority algorithm.\",\n  \"title\": \"\"\n}\n[/block]","category":"55a603ce249a40190051d8f7","excerpt":"This endpoint allows API users to send members an invitation to join the group using the group’s default invitation template.","hidden":false,"order":14,"__v":6,"version":"55a50e92ec735f37000fc6e2","title":"Invite group members","updates":[],"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"next":{"description":"","pages":[]},"childrenPages":[]}

postInvite group members

This endpoint allows API users to send members an invitation to join the group using the group’s default invitation template.

Body Params

sender_id:
required
string
An authorized group members user id which will be presented as the email sender.
recipients_ids:
required
array of integers
Group members user ids. (limited to 500 users on each request)
[block:callout] { "type": "warning", "body": "Note that the invitation service is an ​asynchronous​ service.\nAll the invitation requests are queued on ​the Mobilize platform and will be executed by our priority algorithm.", "title": "" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "warning", "body": "Note that the invitation service is an ​asynchronous​ service.\nAll the invitation requests are queued on ​the Mobilize platform and will be executed by our priority algorithm.", "title": "" } [/block]
{"_id":"5d6f95cdf3db5f002594a953","project":"55a50e92ec735f37000fc6df","version":"55a50e92ec735f37000fc6e2","category":"55a603ce249a40190051d8f7","user":"55a50dd1750a9a23005332c6","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-09-04T10:45:33.998Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"language":"json","code":"{\n    \"job_id\": \"a610e765dc0b7cc48a452157\",\n    \"status\": \"queued\"\n}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"method":"post","examples":{"codes":[{"language":"curl","code":"REQUEST\ncurl 'https://api.mobilize.io/v1/bulk/members'\n    -X POST\n    -u [API Key]:[API Secret]\n    -H 'Content-Type: application/json'\n    -H 'Accept: application/json'\n    -d '{     \n    \t\t\t\"group_id\":1234, \n          \"users\": [\n            {\n              \"fields\":{\n                \"email\":\"[email protected]\",        \t\n                \"first_name\":\"Sam\",\n                \"last_name\":\"Cooper\",\n                \"facebook_url\":\"https://www.facebook.com/path_to_sam_url\"\n              }\n            },\n            {\n              \"fields\": {\n                 \"email\": \"[email protected]\",\n                 \"first_name\": \"Johnny\",\n                 \"last_name\": \"Walker\"\n               }\n            }\n          ]\n    \t\t}'","name":""}]},"auth":"required","params":[{"_id":"55aced6b18eefd0d0071d5f0","ref":"","in":"path","required":true,"desc":"The unique identifier associated to each of your groups.","default":"","type":"int","name":"group_id"},{"_id":"55acfdf1fb7b3c1900373a2d","ref":"","in":"body","required":false,"desc":"An array of users containing fields","default":"","type":"array_object","name":"users"}],"url":"/bulk/members"},"isReference":false,"order":15,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Make sure you include the email in the fields hash.\\nIf the users already exist it will overwrite the data with the data provided in the api body.\\n\\nImportant: The limit for each bulk is 1000 members, and you can only use one bulk api at a time.\",\n  \"title\": \"\"\n}\n[/block]","excerpt":"This api allows you to create members in bulk. \nThe response will return job_id that you will be able to query using the Get bulk import status api.","slug":"create-members-in-bulk","type":"post","title":"Create members in bulk","__v":4,"metadata":{"title":"","description":"","image":[]},"parentDoc":null,"childrenPages":[]}

postCreate members in bulk

This api allows you to create members in bulk. The response will return job_id that you will be able to query using the Get bulk import status api.

Path Params

group_id:
required
integer
The unique identifier associated to each of your groups.

Body Params

users:
array of objects
An array of users containing fields
[block:callout] { "type": "info", "body": "Make sure you include the email in the fields hash.\nIf the users already exist it will overwrite the data with the data provided in the api body.\n\nImportant: The limit for each bulk is 1000 members, and you can only use one bulk api at a time.", "title": "" } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "body": "Make sure you include the email in the fields hash.\nIf the users already exist it will overwrite the data with the data provided in the api body.\n\nImportant: The limit for each bulk is 1000 members, and you can only use one bulk api at a time.", "title": "" } [/block]
{"_id":"5d6f98c0edabc30018c5fb1d","project":"55a50e92ec735f37000fc6df","version":"55a50e92ec735f37000fc6e2","category":"55a603ce249a40190051d8f7","user":"55a50dd1750a9a23005332c6","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-09-04T10:58:08.052Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"name":"","code":"{\n    \"job_id\": \"92eafb8dd3efde8915c05bfc\",\n    \"result\": {\n        \"status\": \"completed\",\n        \"users_imported\": [\n            942671\n        ],\n        \"message\": \"Import succeeded, 1 records imported (1 members)\"\n    }\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"method":"get","examples":{"codes":[{"language":"curl","code":"REQUEST\ncurl 'https://api.mobilize.io/v1/bulk/members/92eafb8dd3efde8915c05bfc'\n\t\t\t-X GET\n      -u [API Key]:[API Secret]\n      -H 'Accept: application/json'","name":""}]},"auth":"required","params":[{"name":"job_id","type":"int","default":"","desc":"The unique identifier associated to the import job returned from bulk add members api","required":true,"in":"path","ref":"","_id":"55aced3218eefd0d0071d5ee"}],"url":"/bulk/members/:job_id"},"isReference":false,"order":16,"body":"","excerpt":"Returns the status of the bulk import.\n\nJob status:\nqueued - The job is queued and waiting to be processed\nprocessing - The job is being processed\ncompleted - The job is completed\nfailed - The job has failed\nWhen the job is failed a message will also be returned indicating the error.\n\nIf the api is successful it will return the imported user ids. \nYou can use these ids to send email invitations, using the Invite group members api.","slug":"get-bulk-import-status","type":"get","title":"Get bulk import members status","__v":1,"metadata":{"title":"","description":"","image":[]},"parentDoc":null,"childrenPages":[]}

getGet bulk import members status

Returns the status of the bulk import. Job status: queued - The job is queued and waiting to be processed processing - The job is being processed completed - The job is completed failed - The job has failed When the job is failed a message will also be returned indicating the error. If the api is successful it will return the imported user ids. You can use these ids to send email invitations, using the Invite group members api.

Path Params

job_id:
required
integer
The unique identifier associated to the import job returned from bulk add members api

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"55a65d89aaf9cf1900115023","sync_unique":"","api":{"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required"},"category":"55a6551c80c8a30d00b325fa","order":0,"__v":6,"githubsync":"","link_external":false,"type":"basic","link_url":"","next":{"description":"","pages":[]},"project":"55a50e92ec735f37000fc6df","slug":"user-object","body":"Users represent members in a community. On the Mobilize platform users may be a member of multiple groups.  \n\nCreating a user does not add them to groups or send an invite to the group member.  Use the Create [group member](https://mobilize.readme.io/docs/create-group-member) to add them directly to a group and use the [Invite Group Member](https://mobilize.readme.io/docs/invite-group-members) to send an invite.\n \nIn general group's admin can decide which information he wants to know about his group members, as detailed in the group object section.\n\nOn Mobilize each member has a default fields such as:\n  * Name\n  * First Name\n  * Last Name\n  * Email \nOther information are optional and can be set as mentioned before by the community admin and the group admin.\n\nIn general field can be one of the following types:\n  * Url\n  * Text\n  * Number\n  * Date\n  * Select (Select)\n  * Multi Select (Check box)\n  * Select (Radio button)\n  * File \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Users Object\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"DEFINITION\\n{\\n  \\\"id\\\": {Text},\\n  \\\"first_name\\\": {Text},\\n  \\\"name\\\": {Text},\\n\\t\\\"last_name\\\": {Text},\\n\\t\\\"email\\\": {Text},\\n  \\\"updated_at\\\": {Numeric},\\n  \\\"created_at\\\": {Numeric},\\n \\t\\\"is_registered\\\": {Boolean},\\n\\t\\\"groups\\\": [\\n\\t\\t{\\n\\t\\t\\t\\\"id\\\": {Numeric},\\n\\t\\t\\t\\\"is_admin\\\": {Boolean},\\n\\t\\t\\t\\\"last_invited_in\\\": {Numeric},\\n      \\\"status\\\": {String} \\n\\t\\t}\\n\\t],\\n\\t\\\"avatar\\\": {\\n\\t\\t\\\"image\\\": {Text},\\n\\t\\t\\\"small_thumb\\\": {Text},\\n\\t\\t\\\"mini_thumb\\\": {Text},\\n\\t\\t\\\"thumb\\\": {Text}\\n\\t},\\n\\t\\n\\t\\\"fields\\\": {\\n\\t\\t...\\n\\t}\\n}\\t\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"id\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Definition\",\n    \"0-2\": \"This is a unique identifier associated to each of your users.\",\n    \"0-1\": \"Text\",\n    \"1-0\": \"avatar\",\n    \"1-1\": \"Object\",\n    \"1-2\": \"The user avatar image url.\\n(image,thumb,mini_thumb,small_thumb)\",\n    \"2-0\": \"email\",\n    \"2-1\": \"Text\",\n    \"3-0\": \"name\",\n    \"3-1\": \"Text\",\n    \"4-0\": \"first_name\",\n    \"4-1\": \"Text\",\n    \"5-0\": \"last_name\",\n    \"5-1\": \"Text\",\n    \"6-0\": \"is_registered\",\n    \"6-1\": \"Boolean\",\n    \"7-0\": \"created_at\",\n    \"8-0\": \"updated_at\",\n    \"9-0\": \"groups\",\n    \"9-1\": \"Object\",\n    \"10-0\": \"fields\",\n    \"10-1\": \"Array\",\n    \"7-1\": \"Numeric\",\n    \"8-1\": \"Numeric\",\n    \"7-2\": \"The time this object was created, in UTC milliseconds past the epoch. This field is automatically updated by writing queries and not directly editable.\",\n    \"8-2\": \"The time this object was last modified, in UTC milliseconds past the epoch. This field is automatically updated by writing queries and not directly editable.\",\n    \"3-2\": \"This is the member full name\",\n    \"10-2\": \"The member organization information by the group fields definition.\\nkey value pair with the unique_name: field_value\",\n    \"9-2\": \"Array of the groups ids the user is a member of.\\nProperties:\\n1. Group id\\n2. Last invite in date,\\n3. Is group admin \\n4. Approval status (accepted, pending, declined)\",\n    \"4-2\": \"This is the member first name\",\n    \"5-2\": \"This is the member last name\",\n    \"2-2\": \"This is the member email address\",\n    \"6-2\": \"Default is false.\\nWith this flag you can know if the user registered to Mobilize platform.\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]","createdAt":"2015-07-15T13:18:01.101Z","excerpt":"","isReference":false,"title":"User Object","updates":[],"user":"55a5d68c80c8a30d00b32498","hidden":false,"version":"55a50e92ec735f37000fc6e2","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

User Object


Users represent members in a community. On the Mobilize platform users may be a member of multiple groups. Creating a user does not add them to groups or send an invite to the group member. Use the Create [group member](https://mobilize.readme.io/docs/create-group-member) to add them directly to a group and use the [Invite Group Member](https://mobilize.readme.io/docs/invite-group-members) to send an invite. In general group's admin can decide which information he wants to know about his group members, as detailed in the group object section. On Mobilize each member has a default fields such as: * Name * First Name * Last Name * Email Other information are optional and can be set as mentioned before by the community admin and the group admin. In general field can be one of the following types: * Url * Text * Number * Date * Select (Select) * Multi Select (Check box) * Select (Radio button) * File [block:api-header] { "type": "basic", "title": "Users Object" } [/block] [block:code] { "codes": [ { "code": "DEFINITION\n{\n \"id\": {Text},\n \"first_name\": {Text},\n \"name\": {Text},\n\t\"last_name\": {Text},\n\t\"email\": {Text},\n \"updated_at\": {Numeric},\n \"created_at\": {Numeric},\n \t\"is_registered\": {Boolean},\n\t\"groups\": [\n\t\t{\n\t\t\t\"id\": {Numeric},\n\t\t\t\"is_admin\": {Boolean},\n\t\t\t\"last_invited_in\": {Numeric},\n \"status\": {String} \n\t\t}\n\t],\n\t\"avatar\": {\n\t\t\"image\": {Text},\n\t\t\"small_thumb\": {Text},\n\t\t\"mini_thumb\": {Text},\n\t\t\"thumb\": {Text}\n\t},\n\t\n\t\"fields\": {\n\t\t...\n\t}\n}\t", "language": "json" } ], "sidebar": true } [/block] [block:parameters] { "data": { "0-0": "id", "h-0": "Name", "h-1": "Type", "h-2": "Definition", "0-2": "This is a unique identifier associated to each of your users.", "0-1": "Text", "1-0": "avatar", "1-1": "Object", "1-2": "The user avatar image url.\n(image,thumb,mini_thumb,small_thumb)", "2-0": "email", "2-1": "Text", "3-0": "name", "3-1": "Text", "4-0": "first_name", "4-1": "Text", "5-0": "last_name", "5-1": "Text", "6-0": "is_registered", "6-1": "Boolean", "7-0": "created_at", "8-0": "updated_at", "9-0": "groups", "9-1": "Object", "10-0": "fields", "10-1": "Array", "7-1": "Numeric", "8-1": "Numeric", "7-2": "The time this object was created, in UTC milliseconds past the epoch. This field is automatically updated by writing queries and not directly editable.", "8-2": "The time this object was last modified, in UTC milliseconds past the epoch. This field is automatically updated by writing queries and not directly editable.", "3-2": "This is the member full name", "10-2": "The member organization information by the group fields definition.\nkey value pair with the unique_name: field_value", "9-2": "Array of the groups ids the user is a member of.\nProperties:\n1. Group id\n2. Last invite in date,\n3. Is group admin \n4. Approval status (accepted, pending, declined)", "4-2": "This is the member first name", "5-2": "This is the member last name", "2-2": "This is the member email address", "6-2": "Default is false.\nWith this flag you can know if the user registered to Mobilize platform." }, "cols": 3, "rows": 11 } [/block]
Users represent members in a community. On the Mobilize platform users may be a member of multiple groups. Creating a user does not add them to groups or send an invite to the group member. Use the Create [group member](https://mobilize.readme.io/docs/create-group-member) to add them directly to a group and use the [Invite Group Member](https://mobilize.readme.io/docs/invite-group-members) to send an invite. In general group's admin can decide which information he wants to know about his group members, as detailed in the group object section. On Mobilize each member has a default fields such as: * Name * First Name * Last Name * Email Other information are optional and can be set as mentioned before by the community admin and the group admin. In general field can be one of the following types: * Url * Text * Number * Date * Select (Select) * Multi Select (Check box) * Select (Radio button) * File [block:api-header] { "type": "basic", "title": "Users Object" } [/block] [block:code] { "codes": [ { "code": "DEFINITION\n{\n \"id\": {Text},\n \"first_name\": {Text},\n \"name\": {Text},\n\t\"last_name\": {Text},\n\t\"email\": {Text},\n \"updated_at\": {Numeric},\n \"created_at\": {Numeric},\n \t\"is_registered\": {Boolean},\n\t\"groups\": [\n\t\t{\n\t\t\t\"id\": {Numeric},\n\t\t\t\"is_admin\": {Boolean},\n\t\t\t\"last_invited_in\": {Numeric},\n \"status\": {String} \n\t\t}\n\t],\n\t\"avatar\": {\n\t\t\"image\": {Text},\n\t\t\"small_thumb\": {Text},\n\t\t\"mini_thumb\": {Text},\n\t\t\"thumb\": {Text}\n\t},\n\t\n\t\"fields\": {\n\t\t...\n\t}\n}\t", "language": "json" } ], "sidebar": true } [/block] [block:parameters] { "data": { "0-0": "id", "h-0": "Name", "h-1": "Type", "h-2": "Definition", "0-2": "This is a unique identifier associated to each of your users.", "0-1": "Text", "1-0": "avatar", "1-1": "Object", "1-2": "The user avatar image url.\n(image,thumb,mini_thumb,small_thumb)", "2-0": "email", "2-1": "Text", "3-0": "name", "3-1": "Text", "4-0": "first_name", "4-1": "Text", "5-0": "last_name", "5-1": "Text", "6-0": "is_registered", "6-1": "Boolean", "7-0": "created_at", "8-0": "updated_at", "9-0": "groups", "9-1": "Object", "10-0": "fields", "10-1": "Array", "7-1": "Numeric", "8-1": "Numeric", "7-2": "The time this object was created, in UTC milliseconds past the epoch. This field is automatically updated by writing queries and not directly editable.", "8-2": "The time this object was last modified, in UTC milliseconds past the epoch. This field is automatically updated by writing queries and not directly editable.", "3-2": "This is the member full name", "10-2": "The member organization information by the group fields definition.\nkey value pair with the unique_name: field_value", "9-2": "Array of the groups ids the user is a member of.\nProperties:\n1. Group id\n2. Last invite in date,\n3. Is group admin \n4. Approval status (accepted, pending, declined)", "4-2": "This is the member first name", "5-2": "This is the member last name", "2-2": "This is the member email address", "6-2": "Default is false.\nWith this flag you can know if the user registered to Mobilize platform." }, "cols": 3, "rows": 11 } [/block]
{"_id":"55a662a980c8a30d00b32634","user":"55a5d68c80c8a30d00b32498","api":{"results":{"codes":[{"status":200,"language":"json","code":"[\n   {\n     \"id\": \"1234\",\n     \"name\": \"Sam Cooper\",\n     \"first_name\": \"Sam\",\n     \"last_name\": \"Cooper\",\n     \"email\": \"[email protected]\",\n     \"updated_at\": 1433233515826,\n     \"created_at\": 1433233515826,\n     \"is_registered\": true,  \n     \"groups\": [\n        {\n           \"id\": 1431,\n           \"is_admin\": false,\n           \"last_invited_in\": 1433869292669,\n           \"status\":\"accepted\"\n     \t\t},\n        {\n           \"id\": 1432,\n           \"is_admin\": false,\n           \"last_invited_in\": 1433869292669,\n           \"status\":\"pending\"\n     \t\t}\n     ],\n     \"avatar\": {\n        \"image\": \"URL to sam's original image\",\n\t\t    \"small_thumb\": \"URL to sam's original image 80x80 px\",\n\t\t    \"mini_thumb\": \"URL to sam's original image 30x30 px\",\n\t\t    \"thumb\": \"URL to sam's original image 280x280 px\"\n     },\n     \"fields\": {\n\t\t\t\t....\n     }     \n  },\n   ...\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/users/","auth":"required","examples":{"codes":[{"language":"curl","code":"REQUEST\ncurl 'https://api.mobilize.io/v1/users'\n    -X GET\n    -u [API Key]:[API Secret]\n   \t-H 'Accept: application/json'","name":""}]},"method":"get","params":[{"name":"include_fields","type":"boolean","default":"","desc":"Indicates whether or not to include the group fields in the response.","required":false,"in":"query","ref":"","_id":"55a662a980c8a30d00b32637"},{"name":"offset","type":"int","default":"0","desc":"The offset from the beginning of the list of users that returns from the query.","required":false,"in":"query","ref":"","_id":"55a662a980c8a30d00b32636"},{"name":"limit","type":"int","default":"50","desc":"The maximum number of users the query will return.","required":false,"in":"query","ref":"","_id":"55a662a980c8a30d00b32635"}]},"editedParams":true,"excerpt":"Return 10 users per call","isReference":false,"next":{"description":"","pages":[]},"sync_unique":"","updates":[],"body":"","category":"55a6551c80c8a30d00b325fa","createdAt":"2015-07-15T13:39:53.280Z","githubsync":"","project":"55a50e92ec735f37000fc6df","type":"get","__v":3,"link_url":"","title":"Get all users","editedParams2":true,"hidden":false,"link_external":false,"order":1,"slug":"get-all-users","version":"55a50e92ec735f37000fc6e2","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getGet all users

Return 10 users per call

Query Params

include_fields:
boolean
Indicates whether or not to include the group fields in the response.
offset:
integer0
The offset from the beginning of the list of users that returns from the query.
limit:
integer50
The maximum number of users the query will return.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"55a668e580c8a30d00b3265c","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"__v":1,"body":"","slug":"get-a-single-user","next":{"description":"","pages":[]},"order":2,"link_url":"","updates":[],"version":"55a50e92ec735f37000fc6e2","category":"55a6551c80c8a30d00b325fa","isReference":false,"type":"get","user":"55a5d68c80c8a30d00b32498","createdAt":"2015-07-15T14:06:29.989Z","title":"Get a single user","project":"55a50e92ec735f37000fc6df","sync_unique":"","api":{"params":[{"required":true,"type":"int","_id":"55a668e580c8a30d00b3265e","default":"","desc":"The unique identifier associated to each of your users.","in":"path","name":"user_id","ref":""},{"in":"query","name":"include_fields","ref":"","required":false,"type":"boolean","_id":"55a668e580c8a30d00b3265d","default":"false","desc":"Indicates whether or not to include the group fields in the response."}],"results":{"codes":[{"code":"{\n     \"id\": \"1234\",\n     \"name\": \"Sam Cooper\",\n     \"first_name\": \"Sam\",\n     \"last_name\": \"Cooper\",\n     \"email\": \"[email protected]\",\n     \"updated_at\": 1433233515826,\n     \"created_at\": 1433233515826,\n     \"is_registered\": true,  \n     \"groups\": [\n        {\n           \"id\": 1431,\n           \"is_admin\": false,\n           \"last_invited_in\": 1433869292669,\n           \"status\":\"accepted\"\n     \t\t}\n     ],\n     \"avatar\": {\n        \"image\": {URL to sam's original image},\n        \"small_thumb\": {URL to sam's original image 80x80 px},\n        \"mini_thumb\": {URL to sam's original image 30x30 px},\n        \"thumb\": {URL to sam's original image 280x280 px}\n     },\n     \"fields\": {\n\t\t\t\t....\n     }     \n   }","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"/users/:user_id/","auth":"required","examples":{"codes":[{"language":"curl","code":"REQUEST\ncurl 'https://api.mobilize.io/v1/users/1234'\n    -X GET\n    -u [API Key]:[API Secret]\n   \t-H 'Accept: application/json'","name":""}]},"method":"get"},"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getGet a single user


Path Params

user_id:
required
integer
The unique identifier associated to each of your users.

Query Params

include_fields:
booleanfalse
Indicates whether or not to include the group fields in the response.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"55a66e5380c8a30d00b32678","api":{"url":"/users/","auth":"required","examples":{"codes":[{"language":"curl","code":"curl 'https://api.mobilize.io/v1/users/'\n    -X POST\n    -u [API Key]:[API Secret]\n    -H 'Content-Type: application/json'\n    -H 'Accept: application/json'\n    -d '{        \n     \t\t\t\"email\":\"[email protected]\",\n          \"fields\":{          \t           \n            \"first_name\":\"Sam\",\n            \"last_name\":\"Cooper\"           \n          }\n    \t\t}'","name":""}]},"method":"post","params":[{"name":"email","type":"string","default":"","desc":"The user email address.","required":true,"in":"body","ref":"","_id":"55a66e5380c8a30d00b3267a"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n     \"id\": \"1234\",\n     \"name\": \"Sam Cooper\",\n     \"first_name\": \"Sam\",\n     \"last_name\": \"Cooper\",\n     \"email\": \"[email protected]\",\n     \"updated_at\": 1433233515826,\n     \"created_at\": 1433233515826,\n     \"is_registered\": true,  \n     \"groups\": [\n        {\n           \"id\": 1234,\n           \"is_admin\": false,\n           \"last_invited_in\": 1433869292669,\n           \"status\":\"accepted\"\n     \t\t}\n     ],\n     \"avatar\": {\n       \"image\": \"URL to sam's original image\",\n\t\t   \"small_thumb\": \"URL to sam's original image 80x80 px\",\n\t\t   \"mini_thumb\": \"URL to sam's original image 30x30 px\",\n\t\t   \"thumb\": \"URL to sam's original image 280x280 px\"\n     },\n     \"fields\": {            \n\t\t\t\t \"email\":\"[email protected]\",\n         \"first_name\":\"Sam\",\n         \"last_name\":\"Cooper\"    \n     }     \n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"createdAt":"2015-07-15T14:29:39.565Z","editedParams":true,"isReference":false,"order":3,"slug":"create-a-single-user","sync_unique":"","__v":4,"updates":[],"user":"55a5d68c80c8a30d00b32498","type":"post","hidden":false,"next":{"description":"","pages":[]},"version":"55a50e92ec735f37000fc6e2","category":"55a6551c80c8a30d00b325fa","editedParams2":true,"excerpt":"","link_external":false,"link_url":"","project":"55a50e92ec735f37000fc6df","title":"Create a single user","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Creating a user does not add them to groups or send an invite to the group member.  Use the Create [group member](https://mobilize.readme.io/docs/create-group-member) to add them directly to a group and use the [Invite Group Member](https://mobilize.readme.io/docs/invite-group-members) to send an invite.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"Updating of a field from type file, is not yet supported.\\nPlease contact your customer success manager with any questions or comments.\"\n}\n[/block]","githubsync":"","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

postCreate a single user


Body Params

email:
required
string
The user email address.
[block:callout] { "type": "info", "body": "Creating a user does not add them to groups or send an invite to the group member. Use the Create [group member](https://mobilize.readme.io/docs/create-group-member) to add them directly to a group and use the [Invite Group Member](https://mobilize.readme.io/docs/invite-group-members) to send an invite." } [/block] [block:callout] { "type": "danger", "body": "Updating of a field from type file, is not yet supported.\nPlease contact your customer success manager with any questions or comments." } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "info", "body": "Creating a user does not add them to groups or send an invite to the group member. Use the Create [group member](https://mobilize.readme.io/docs/create-group-member) to add them directly to a group and use the [Invite Group Member](https://mobilize.readme.io/docs/invite-group-members) to send an invite." } [/block] [block:callout] { "type": "danger", "body": "Updating of a field from type file, is not yet supported.\nPlease contact your customer success manager with any questions or comments." } [/block]
{"_id":"55a6709980c8a30d00b32688","link_external":false,"title":"Update a single user","type":"put","createdAt":"2015-07-15T14:39:21.685Z","editedParams":true,"excerpt":"","hidden":false,"isReference":false,"editedParams2":true,"next":{"description":"","pages":[]},"slug":"update-a-single-user","version":"55a50e92ec735f37000fc6e2","api":{"results":{"codes":[{"name":"","code":"{\n     \"id\": \"1234\",\n     \"name\": \"Sam Cooper\",\n     \"first_name\": \"Sam\",\n     \"last_name\": \"Cooper\",\n     \"email\": \"[email protected]\",\n     \"updated_at\": 1433233515826,\n     \"created_at\": 1433233515826,\n     \"is_registered\": true,  \n     \"groups\": [\n        {\n           \"id\": 1234,\n           \"is_admin\": false,\n           \"last_invited_in\": 1433869292669,\n\t\t\t\t\t \"status\":\"accepted\"\n     \t\t}\n     ],\n     \"avatar\": {\n        ...\n     },\n     \"fields\": {\n       \"facebook_url\":\"https://www.facebook.com/path_to_sam_url\",\n       \"birthday\":1436907600,         \t\n       \"email\":\"[email protected]\",\n       \"first_name\":\"Sam\",\n       \"last_name\":\"Cooper\"                     \n     }     \n}","language":"json","status":200},{"status":422,"name":"","code":"{\n    \"error_message\": \"'fields' property is missing, please validate your request.\",\n    \"status_code\": 422\n}\n","language":"json"}]},"settings":"","url":"/users/:id","auth":"required","examples":{"codes":[{"name":"","code":"curl 'https://api.mobilize.io/v1/users/1234'\n    -X POST\n    -u [API Key]:[API Secret]\n    -H 'Content-Type: application/json'\n    -H 'Accept: application/json'\n    -d '{    \t\t\t\n          \"fields\":{\n          \t\"birthday\":1436907600\n          }\n    \t\t}'","language":"curl"}]},"method":"put","params":[{"desc":"The unique identifier associated to each of your users.","in":"path","name":"id","ref":"","required":true,"type":"int","_id":"55a6709980c8a30d00b32689","default":""},{"in":"body","name":"fields","ref":"","required":true,"type":"object","_id":"55a6717951457325000e4d94","default":"","desc":"Key value object that represent unique_field_name:field value"}]},"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"Updating of a field from type file, is not yet supported.\\nPlease contact your customer success manager with any questions or comments\"\n}\n[/block]","order":4,"sync_unique":"","updates":[],"project":"55a50e92ec735f37000fc6df","user":"55a5d68c80c8a30d00b32498","__v":3,"category":"55a6551c80c8a30d00b325fa","githubsync":"","link_url":"","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

putUpdate a single user


Path Params

id:
required
integer
The unique identifier associated to each of your users.

Body Params

fields:
required
object
Key value object that represent unique_field_name:field value
[block:callout] { "type": "danger", "body": "Updating of a field from type file, is not yet supported.\nPlease contact your customer success manager with any questions or comments" } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



[block:callout] { "type": "danger", "body": "Updating of a field from type file, is not yet supported.\nPlease contact your customer success manager with any questions or comments" } [/block]
{"_id":"55a677eaaaf9cf19001150b1","excerpt":"","title":"Delete a single user","user":"55a5d68c80c8a30d00b32498","api":{"method":"delete","params":[{"_id":"55a677eaaaf9cf19001150b3","ref":"","in":"path","required":true,"desc":"The unique identifier associated to each of your users.","default":"","type":"int","name":"user_id"},{"_id":"5b05529668e80a0003e73f61","ref":"","in":"path","required":false,"desc":"Indicate whether or not to delete all the content the user created in the community","default":"false","type":"boolean","name":"hard_delete"}],"results":{"codes":[{"name":"","code":"{ \"success\":true }","language":"json","status":200},{"name":"","code":"{\n  error_code:404,\n \"error_message\":\"User id(user_id) is not exist.\"\n}","language":"json","status":404},{"status":400,"language":"json","code":"{\n  \"error_code\":404,\n  \"error_message\":\"User id is missing, please validate your request.\"\n}"}]},"settings":"","url":"/users/:user_id","auth":"required","examples":{"codes":[{"language":"curl","code":"curl 'https://api.mobilize.io/v1/users/1234\n    -X DELETE\n    -u [API Key]:[API Secret]\n    -H 'Accept: application/json'","name":""}]}},"createdAt":"2015-07-15T15:10:34.707Z","editedParams":true,"updates":[],"version":"55a50e92ec735f37000fc6e2","hidden":false,"link_external":false,"order":5,"sync_unique":"","body":"","category":"55a6551c80c8a30d00b325fa","githubsync":"","project":"55a50e92ec735f37000fc6df","slug":"delete-a-single-user","type":"delete","__v":2,"editedParams2":true,"link_url":"","isReference":false,"next":{"description":"","pages":[]},"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

deleteDelete a single user


Path Params

user_id:
required
integer
The unique identifier associated to each of your users.
hard_delete:
booleanfalse
Indicate whether or not to delete all the content the user created in the community

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"569eaa76d233620d007055d1","createdAt":"2016-01-19T21:28:22.323Z","next":{"description":"","pages":[]},"slug":"search-for-users","sync_unique":"","api":{"examples":{"codes":[{"language":"curl","code":"curl 'https://api.mobilize.io/v1/users/search?keywords=sam_cooper%40domain.com'\n    -X GET\n    -u [API Key]:[API Secret]\n    -H 'Accept: application/json'"}]},"method":"get","params":[{"required":true,"type":"string","_id":"569eaf5ac9b43e0d00c4baf1","default":"","desc":"URI Generic Syntax by rfc2396 definition","in":"path","name":"keywords","ref":""},{"name":"offset","ref":"","required":false,"type":"int","_id":"569eaf5ac9b43e0d00c4baf0","default":"0","desc":"The offset from the beginning of the list of users that returns from the query.","in":"path"},{"type":"int","_id":"569eaf5ac9b43e0d00c4baef","default":"50","desc":"The maximum number of users the query will return.","in":"path","name":"limit","ref":"","required":false},{"required":false,"type":"boolean","_id":"569eb197ffccd10d00a05c90","default":"false","desc":"Indicates whether or not to include the group fields in the response.","in":"path","name":"include_fields","ref":""}],"results":{"codes":[{"language":"json","code":"[\n   {\n     \"id\": \"1234\",\n     \"name\": \"Sam Cooper\",\n     \"first_name\": \"Sam\",\n     \"last_name\": \"Cooper\",\n     \"email\": \"[email protected]\",\n     \"updated_at\": 1433233515826,\n     \"created_at\": 1433233515826,\n     \"is_registered\": true,  \n     \"groups\": [\n        {\n           \"id\": 1431,\n           \"is_admin\": false,\n           \"last_invited_in\": 1433869292669,\n           \"status\":\"accepted\"\n        },\n        {\n           \"id\": 1432,\n           \"is_admin\": false,\n           \"last_invited_in\": 1433869292669,\n           \"status\":\"accepted\"\n        }\n     ],\n     \"avatar\": {\n        \"image\": \"URL to sam's original image\",\n        \"small_thumb\": \"URL to sam's original image 80x80 px\",\n        \"mini_thumb\": \"URL to sam's original image 30x30 px\",\n        \"thumb\": \"URL to sam's original image 280x280 px\"\n     },\n     \"fields\": {\n        ....\n     }     \n  },\n   ...\n]","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"/users/search?:keywords&:offset&:limit&:include_fields","auth":"required"},"editedParams":true,"editedParams2":true,"githubsync":"","link_url":"","project":"55a50e92ec735f37000fc6df","title":"Search for users","__v":4,"excerpt":"On the Mobilize platform, users are able to search for users by the metadata in the fields.\nAs this is a powerful feature we have also enabled this ability for our API users.","hidden":false,"isReference":false,"order":6,"version":"55a50e92ec735f37000fc6e2","category":"55a6551c80c8a30d00b325fa","link_external":false,"type":"get","updates":[],"user":"55a50dd1750a9a23005332c6","body":"","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getSearch for users

On the Mobilize platform, users are able to search for users by the metadata in the fields. As this is a powerful feature we have also enabled this ability for our API users.

Path Params

keywords:
required
string
URI Generic Syntax by rfc2396 definition
offset:
integer0
The offset from the beginning of the list of users that returns from the query.
limit:
integer50
The maximum number of users the query will return.
include_fields:
booleanfalse
Indicates whether or not to include the group fields in the response.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"59244c701e32eb190028ad5b","link_url":"","githubsync":"","body":"","excerpt":"Find user by email","next":{"pages":[],"description":""},"link_external":false,"user":"55a50dd1750a9a23005332c6","updates":[],"api":{"examples":{"codes":[{"language":"curl","code":"curl 'https://api.mobilize.io/v1/users/find_by_email?email=sam_cooper%40domain.com&include_fields=true'\n    -X GET\n    -u [API Key]:[API Secret]\n    -H 'Accept: application/json'"}]},"auth":"required","params":[{"desc":"URI Generic Syntax by rfc2396 definition","default":"","type":"string","name":"email","_id":"569eaf5ac9b43e0d00c4baf1","ref":"","in":"path","required":true},{"_id":"569eb197ffccd10d00a05c90","ref":"","in":"path","required":false,"desc":"Indicates whether or not to include the group fields in the response.","default":"false","type":"boolean","name":"include_fields"}],"url":"/users/find_by_email?:email&:include_fields","settings":"","results":{"codes":[{"status":200,"language":"json","code":"[\n   {\n     \"id\": \"1234\",\n     \"name\": \"Sam Cooper\",\n     \"first_name\": \"Sam\",\n     \"last_name\": \"Cooper\",\n     \"email\": \"[email protected]\",\n     \"updated_at\": 1433233515826,\n     \"created_at\": 1433233515826,\n     \"is_registered\": true,  \n     \"groups\": [\n        {\n           \"id\": 1431,\n           \"is_admin\": false,\n           \"last_invited_in\": 1433869292669,\n           \"status\":\"accepted\"\n        },\n        {\n           \"id\": 1432,\n           \"is_admin\": false,\n           \"last_invited_in\": 1433869292669,\n           \"status\":\"accepted\"\n        }\n     ],\n     \"avatar\": {\n        \"image\": \"URL to sam's original image\",\n        \"small_thumb\": \"URL to sam's original image 80x80 px\",\n        \"mini_thumb\": \"URL to sam's original image 30x30 px\",\n        \"thumb\": \"URL to sam's original image 280x280 px\"\n     },\n     \"fields\": {\n        ....\n     }     \n  },\n   ...\n]","name":""},{"language":"json","code":"{}","name":"","status":400}]},"method":"get"},"isReference":false,"order":7,"project":"55a50e92ec735f37000fc6df","version":"55a50e92ec735f37000fc6e2","createdAt":"2017-05-23T14:51:28.758Z","__v":0,"hidden":false,"slug":"find-by-email","type":"get","title":"Find by email","category":"55a6551c80c8a30d00b325fa","sync_unique":"","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getFind by email

Find user by email

Path Params

email:
required
string
URI Generic Syntax by rfc2396 definition
include_fields:
booleanfalse
Indicates whether or not to include the group fields in the response.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"55a769793efe0c2f0074c8d6","version":"55a50e92ec735f37000fc6e2","body":"FieldDefinition is a set of configurations that describe a property that community admins or  group admins may define.\nEach field represent a column in your community CRM system.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"FieldDefinition Object\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Definition\",\n    \"0-0\": \"id\",\n    \"0-1\": \"Numeric\",\n    \"0-2\": \"This is a unique identifier.\",\n    \"1-0\": \"name\",\n    \"1-1\": \"Text\",\n    \"1-2\": \"This is the name of the field.\",\n    \"2-0\": \"type\",\n    \"2-1\": \"Text\",\n    \"2-2\": \"This represent the visual type of the field in the registration form.\\n**fields type**:\\n  * text\\n  * number\\n  * url\\n  * textArea\\n  * checkbox\\n  * radio\\n  * select\\n  * date\\n  * file*\\n  * phone (Format expected is: \\\"+14155552671\\\")\\n  * location\",\n    \"3-0\": \"unique_name\",\n    \"3-1\": \"Text\",\n    \"4-0\": \"options\",\n    \"4-1\": \"Array[Text]\",\n    \"4-2\": \"Represent an array of strings that describe the option name.\\nfields options can be attached to thous types: \\n  * checkbox\\n  * select\\n  * radio\",\n    \"5-0\": \"other_option_flag\",\n    \"5-1\": \"Boolean\",\n    \"5-2\": \"This flag indicates that members can add their own option.\",\n    \"6-0\": \"placeholder\",\n    \"6-1\": \"Text\",\n    \"6-2\": \"A text that describes the field when no input was filled by the user.\",\n    \"7-0\": \"required\",\n    \"7-1\": \"Boolean\",\n    \"7-2\": \"Indicates whether or not this field is required to fill in by the members.\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" {\\n\\t\\\"required\\\": true,\\n\\t\\\"options\\\": null,\\n\\t\\\"other_option_flag\\\": false,\\n\\t\\\"placeholder\\\": \\\"please fill in your first name.\\\",\\n\\t\\\"name\\\": \\\"First Name\\\",\\n\\t\\\"type\\\": \\\"text\\\",\\n\\t\\\"id\\\": 4213,\\n\\t\\\"unique_name\\\": \\\"first_name\\\",\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" {\\n\\t\\\"required\\\": false,\\n\\t\\\"options\\\": ['Options 1','Options 2','Options 3'],\\n\\t\\\"other_option_flag\\\": true,\\n\\t\\\"placeholder\\\": null,\\n\\t\\\"name\\\": \\\"Selection field\\\",\\n\\t\\\"type\\\": \\\"select\\\",\\n\\t\\\"id\\\": 4213,\\n\\t\\\"unique_name\\\": \\\"select\\\",\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","hidden":false,"link_url":"","project":"55a50e92ec735f37000fc6df","user":"55a5d68c80c8a30d00b32498","api":{"auth":"required","params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"createdAt":"2015-07-16T08:21:13.277Z","__v":16,"link_external":false,"slug":"fileddefinition-object","sync_unique":"","title":"FieldDefinition object","type":"basic","updates":[],"category":"55a767043efe0c2f0074c8cb","excerpt":"","githubsync":"","order":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

FieldDefinition object


FieldDefinition is a set of configurations that describe a property that community admins or group admins may define. Each field represent a column in your community CRM system. [block:api-header] { "type": "basic", "title": "FieldDefinition Object" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Definition", "0-0": "id", "0-1": "Numeric", "0-2": "This is a unique identifier.", "1-0": "name", "1-1": "Text", "1-2": "This is the name of the field.", "2-0": "type", "2-1": "Text", "2-2": "This represent the visual type of the field in the registration form.\n**fields type**:\n * text\n * number\n * url\n * textArea\n * checkbox\n * radio\n * select\n * date\n * file*\n * phone (Format expected is: \"+14155552671\")\n * location", "3-0": "unique_name", "3-1": "Text", "4-0": "options", "4-1": "Array[Text]", "4-2": "Represent an array of strings that describe the option name.\nfields options can be attached to thous types: \n * checkbox\n * select\n * radio", "5-0": "other_option_flag", "5-1": "Boolean", "5-2": "This flag indicates that members can add their own option.", "6-0": "placeholder", "6-1": "Text", "6-2": "A text that describes the field when no input was filled by the user.", "7-0": "required", "7-1": "Boolean", "7-2": "Indicates whether or not this field is required to fill in by the members." }, "cols": 3, "rows": 8 } [/block] [block:code] { "codes": [ { "code": " {\n\t\"required\": true,\n\t\"options\": null,\n\t\"other_option_flag\": false,\n\t\"placeholder\": \"please fill in your first name.\",\n\t\"name\": \"First Name\",\n\t\"type\": \"text\",\n\t\"id\": 4213,\n\t\"unique_name\": \"first_name\",\n}", "language": "json" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": " {\n\t\"required\": false,\n\t\"options\": ['Options 1','Options 2','Options 3'],\n\t\"other_option_flag\": true,\n\t\"placeholder\": null,\n\t\"name\": \"Selection field\",\n\t\"type\": \"select\",\n\t\"id\": 4213,\n\t\"unique_name\": \"select\",\n}", "language": "json" } ], "sidebar": true } [/block]
FieldDefinition is a set of configurations that describe a property that community admins or group admins may define. Each field represent a column in your community CRM system. [block:api-header] { "type": "basic", "title": "FieldDefinition Object" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Definition", "0-0": "id", "0-1": "Numeric", "0-2": "This is a unique identifier.", "1-0": "name", "1-1": "Text", "1-2": "This is the name of the field.", "2-0": "type", "2-1": "Text", "2-2": "This represent the visual type of the field in the registration form.\n**fields type**:\n * text\n * number\n * url\n * textArea\n * checkbox\n * radio\n * select\n * date\n * file*\n * phone (Format expected is: \"+14155552671\")\n * location", "3-0": "unique_name", "3-1": "Text", "4-0": "options", "4-1": "Array[Text]", "4-2": "Represent an array of strings that describe the option name.\nfields options can be attached to thous types: \n * checkbox\n * select\n * radio", "5-0": "other_option_flag", "5-1": "Boolean", "5-2": "This flag indicates that members can add their own option.", "6-0": "placeholder", "6-1": "Text", "6-2": "A text that describes the field when no input was filled by the user.", "7-0": "required", "7-1": "Boolean", "7-2": "Indicates whether or not this field is required to fill in by the members." }, "cols": 3, "rows": 8 } [/block] [block:code] { "codes": [ { "code": " {\n\t\"required\": true,\n\t\"options\": null,\n\t\"other_option_flag\": false,\n\t\"placeholder\": \"please fill in your first name.\",\n\t\"name\": \"First Name\",\n\t\"type\": \"text\",\n\t\"id\": 4213,\n\t\"unique_name\": \"first_name\",\n}", "language": "json" } ], "sidebar": true } [/block] [block:code] { "codes": [ { "code": " {\n\t\"required\": false,\n\t\"options\": ['Options 1','Options 2','Options 3'],\n\t\"other_option_flag\": true,\n\t\"placeholder\": null,\n\t\"name\": \"Selection field\",\n\t\"type\": \"select\",\n\t\"id\": 4213,\n\t\"unique_name\": \"select\",\n}", "language": "json" } ], "sidebar": true } [/block]
{"_id":"5639e017a19edf0d00972244","type":"basic","githubsync":"","link_external":false,"createdAt":"2015-11-04T10:38:15.841Z","order":1,"project":"55a50e92ec735f37000fc6df","user":"55a50dd1750a9a23005332c6","category":"55a767043efe0c2f0074c8cb","link_url":"","sync_unique":"","version":"55a50e92ec735f37000fc6e2","__v":4,"api":{"auth":"required","params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":""},"hidden":false,"slug":"locationfield-object","title":"LocationField object","updates":[],"body":"LocationField is a set of fields that describes a location.\nIt is used as the value of a user field of type 'location'\nWhen updating a user's location field, fields that are not on the list below are dropped.\nAll the fields are optional unless specified in the field configuration on mobilize web site.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"LocationField Object\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Definition\",\n    \"0-0\": \"place_id\",\n    \"0-1\": \"Text\",\n    \"0-2\": \"Reference on Google Maps\\n([example](https://goo.gl/TUqPv7))\",\n    \"1-0\": \"lat\",\n    \"1-1\": \"Number\",\n    \"1-2\": \"latitude coordinates of the location\",\n    \"2-0\": \"lng\",\n    \"2-1\": \"Number\",\n    \"2-2\": \"longitude coordinates of the location\",\n    \"3-0\": \"formatted_address\",\n    \"3-1\": \"Text\",\n    \"4-0\": \"country\",\n    \"4-1\": \"Text\",\n    \"4-2\": \"indicates the national political entity\",\n    \"5-0\": \"state\",\n    \"5-1\": \"Text\",\n    \"5-2\": \"indicates a state or other first-order civil entity below the country level\",\n    \"6-0\": \"city\",\n    \"6-1\": \"Text\",\n    \"6-2\": \"indicates an incorporated city or town political entity\",\n    \"7-0\": \"postal_code\",\n    \"7-1\": \"Text\",\n    \"7-2\": \"indicates a postal code as used to address postal mail within the country\",\n    \"8-0\": \"street_name\",\n    \"9-0\": \"street_number\",\n    \"3-2\": \"a human-readable address for displaying in mobilize.io\",\n    \"8-2\": \"indicates a street name or another named route (such as \\\"US 101\\\")\",\n    \"9-2\": \"indicates the precise street number\",\n    \"8-1\": \"Text\",\n    \"9-1\": \"Number\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" {\\n   \\\"place_id\\\": \\\"ChIJnySwn4mAhYARnYlWZeajtew\\\",\\n   \\\"lat\\\": 37.7900112,\\n   \\\"lng\\\": -122.4041154,\\n   \\\"formatted_address\\\": \\\"209 Kearny St, San Francisco, CA 94108, USA\\\",\\n   \\\"country\\\": \\\"United States\\\",\\n   \\\"state\\\": \\\"California\\\",\\n   \\\"city\\\": \\\"San Francisco\\\",\\n   \\\"postal_code\\\": \\\"94108\\\",\\n   \\\"street_name\\\": \\\"Kearny Street\\\",\\n   \\\"street_number\\\": \\\"209\\\"\\n }\",\n      \"language\": \"json\",\n      \"name\": null\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

LocationField object


LocationField is a set of fields that describes a location. It is used as the value of a user field of type 'location' When updating a user's location field, fields that are not on the list below are dropped. All the fields are optional unless specified in the field configuration on mobilize web site. [block:api-header] { "type": "basic", "title": "LocationField Object" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Definition", "0-0": "place_id", "0-1": "Text", "0-2": "Reference on Google Maps\n([example](https://goo.gl/TUqPv7))", "1-0": "lat", "1-1": "Number", "1-2": "latitude coordinates of the location", "2-0": "lng", "2-1": "Number", "2-2": "longitude coordinates of the location", "3-0": "formatted_address", "3-1": "Text", "4-0": "country", "4-1": "Text", "4-2": "indicates the national political entity", "5-0": "state", "5-1": "Text", "5-2": "indicates a state or other first-order civil entity below the country level", "6-0": "city", "6-1": "Text", "6-2": "indicates an incorporated city or town political entity", "7-0": "postal_code", "7-1": "Text", "7-2": "indicates a postal code as used to address postal mail within the country", "8-0": "street_name", "9-0": "street_number", "3-2": "a human-readable address for displaying in mobilize.io", "8-2": "indicates a street name or another named route (such as \"US 101\")", "9-2": "indicates the precise street number", "8-1": "Text", "9-1": "Number" }, "cols": 3, "rows": 10 } [/block] [block:code] { "codes": [ { "code": " {\n \"place_id\": \"ChIJnySwn4mAhYARnYlWZeajtew\",\n \"lat\": 37.7900112,\n \"lng\": -122.4041154,\n \"formatted_address\": \"209 Kearny St, San Francisco, CA 94108, USA\",\n \"country\": \"United States\",\n \"state\": \"California\",\n \"city\": \"San Francisco\",\n \"postal_code\": \"94108\",\n \"street_name\": \"Kearny Street\",\n \"street_number\": \"209\"\n }", "language": "json", "name": null } ], "sidebar": true } [/block]
LocationField is a set of fields that describes a location. It is used as the value of a user field of type 'location' When updating a user's location field, fields that are not on the list below are dropped. All the fields are optional unless specified in the field configuration on mobilize web site. [block:api-header] { "type": "basic", "title": "LocationField Object" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Definition", "0-0": "place_id", "0-1": "Text", "0-2": "Reference on Google Maps\n([example](https://goo.gl/TUqPv7))", "1-0": "lat", "1-1": "Number", "1-2": "latitude coordinates of the location", "2-0": "lng", "2-1": "Number", "2-2": "longitude coordinates of the location", "3-0": "formatted_address", "3-1": "Text", "4-0": "country", "4-1": "Text", "4-2": "indicates the national political entity", "5-0": "state", "5-1": "Text", "5-2": "indicates a state or other first-order civil entity below the country level", "6-0": "city", "6-1": "Text", "6-2": "indicates an incorporated city or town political entity", "7-0": "postal_code", "7-1": "Text", "7-2": "indicates a postal code as used to address postal mail within the country", "8-0": "street_name", "9-0": "street_number", "3-2": "a human-readable address for displaying in mobilize.io", "8-2": "indicates a street name or another named route (such as \"US 101\")", "9-2": "indicates the precise street number", "8-1": "Text", "9-1": "Number" }, "cols": 3, "rows": 10 } [/block] [block:code] { "codes": [ { "code": " {\n \"place_id\": \"ChIJnySwn4mAhYARnYlWZeajtew\",\n \"lat\": 37.7900112,\n \"lng\": -122.4041154,\n \"formatted_address\": \"209 Kearny St, San Francisco, CA 94108, USA\",\n \"country\": \"United States\",\n \"state\": \"California\",\n \"city\": \"San Francisco\",\n \"postal_code\": \"94108\",\n \"street_name\": \"Kearny Street\",\n \"street_number\": \"209\"\n }", "language": "json", "name": null } ], "sidebar": true } [/block]
{"_id":"55d215de945e481700afbb3f","createdAt":"2015-08-17T17:11:58.132Z","hidden":false,"title":"Webhooks","type":"basic","__v":36,"githubsync":"","isReference":false,"link_url":"","order":0,"body":"You may use webhooks to receive notifications, such as users being created and updated. Notifications are grouped into topics which can be subscribed to.\n\nYou can create multiple webhooks that can listen for the notifications. When you add multiple webhooks you need to use api_application_key param for every request to show which key you are using for the webhooks.\n\nMobilize allows users to create and update multiple items at once for example: upload an excel of users or upload users email list.\nAs a result of that we created the [bulk notification object](https://dash.readme.io/project/mobilize/v1/docs/bulk-notifications-object). This object allows us to update you about all the items that has been created/changed through [notification objects](https://dash.readme.io/project/mobilize/v1/docs/notification-object), for more information please review: [bulk notification object](https://dash.readme.io/project/mobilize/v1/docs/bulk-notifications-object) and [notification object](https://dash.readme.io/project/mobilize/v1/docs/notification-object) topics.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"The webhook API currently supports users and group members. Future considerations for improvements to the webhook API capabilities include groups and posts.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Adding New Webhook\"\n}\n[/block]\nIn the \"Community Settings\" -> \"integrations\" you click on \"Create new API key\" and a new key will be generated. Make sure to store safely **API Application** key and **Secret key**. In case you lose them you need to generate a new API key and destroy the old one.\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/67284e3-Screenshot_2019-12-16_16.40.32.png\",\n        \"Screenshot 2019-12-16 16.40.32.png\",\n        1160,\n        390,\n        \"#ced8d8\"\n      ]\n    }\n  ]\n}\n[/block]\nA webhook subscription may be configured in the \"Community Settings\" -> \"integrations\" . Clicking \"Webhooks Options\" will show a form for editing the subscription.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/QQMdXmZzTeSjXajP5e68_Screen%20Shot%202015-08-18%20at%202.07.09%20PM.png\",\n        \"Screen Shot 2015-08-18 at 2.07.09 PM.png\",\n        \"1010\",\n        \"292\",\n        \"#417d80\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nMake sure to select the notifications checkboxes to subscribe to specific events\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/8ee7d6b-Screen_Shot_2016-11-07_at_3.44.33_PM.png\",\n        \"Screen Shot 2016-11-07 at 3.44.33 PM.png\",\n        1160,\n        842,\n        \"#262732\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Securing Webhooks\"\n}\n[/block]\nWe support HTTP and HTTPS subscription URLs, and we recommend you provide a HTTPS URL to protect notifications.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Supported Topics\"\n}\n[/block]\nThe following topics may be subscribed to:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Topic Description\",\n    \"h-1\": \"Notification type\",\n    \"0-0\": \"User Created\",\n    \"0-1\": \"user.created\",\n    \"1-0\": \"User Updated\",\n    \"1-1\": \"user.updated\",\n    \"2-0\": \"User Status Changed\",\n    \"2-1\": \"user.status_changed\",\n    \"3-0\": \"Group Member Accept\",\n    \"3-1\": \"group_member.added\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","category":"55d07a212096360d00713799","link_external":false,"next":{"description":"","pages":[]},"sync_unique":"","version":"55a50e92ec735f37000fc6e2","api":{"auth":"required","params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"excerpt":"","project":"55a50e92ec735f37000fc6df","slug":"webhooks","updates":[],"user":"55a50dd1750a9a23005332c6","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Webhooks


You may use webhooks to receive notifications, such as users being created and updated. Notifications are grouped into topics which can be subscribed to. You can create multiple webhooks that can listen for the notifications. When you add multiple webhooks you need to use api_application_key param for every request to show which key you are using for the webhooks. Mobilize allows users to create and update multiple items at once for example: upload an excel of users or upload users email list. As a result of that we created the [bulk notification object](https://dash.readme.io/project/mobilize/v1/docs/bulk-notifications-object). This object allows us to update you about all the items that has been created/changed through [notification objects](https://dash.readme.io/project/mobilize/v1/docs/notification-object), for more information please review: [bulk notification object](https://dash.readme.io/project/mobilize/v1/docs/bulk-notifications-object) and [notification object](https://dash.readme.io/project/mobilize/v1/docs/notification-object) topics. [block:callout] { "type": "info", "body": "The webhook API currently supports users and group members. Future considerations for improvements to the webhook API capabilities include groups and posts." } [/block] [block:api-header] { "type": "basic", "title": "Adding New Webhook" } [/block] In the "Community Settings" -> "integrations" you click on "Create new API key" and a new key will be generated. Make sure to store safely **API Application** key and **Secret key**. In case you lose them you need to generate a new API key and destroy the old one. [block:image] { "images": [ { "image": [ "https://files.readme.io/67284e3-Screenshot_2019-12-16_16.40.32.png", "Screenshot 2019-12-16 16.40.32.png", 1160, 390, "#ced8d8" ] } ] } [/block] A webhook subscription may be configured in the "Community Settings" -> "integrations" . Clicking "Webhooks Options" will show a form for editing the subscription. [block:image] { "images": [ { "image": [ "https://files.readme.io/QQMdXmZzTeSjXajP5e68_Screen%20Shot%202015-08-18%20at%202.07.09%20PM.png", "Screen Shot 2015-08-18 at 2.07.09 PM.png", "1010", "292", "#417d80", "" ] } ] } [/block] Make sure to select the notifications checkboxes to subscribe to specific events [block:image] { "images": [ { "image": [ "https://files.readme.io/8ee7d6b-Screen_Shot_2016-11-07_at_3.44.33_PM.png", "Screen Shot 2016-11-07 at 3.44.33 PM.png", 1160, 842, "#262732" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Securing Webhooks" } [/block] We support HTTP and HTTPS subscription URLs, and we recommend you provide a HTTPS URL to protect notifications. [block:api-header] { "type": "basic", "title": "Supported Topics" } [/block] The following topics may be subscribed to: [block:parameters] { "data": { "h-0": "Topic Description", "h-1": "Notification type", "0-0": "User Created", "0-1": "user.created", "1-0": "User Updated", "1-1": "user.updated", "2-0": "User Status Changed", "2-1": "user.status_changed", "3-0": "Group Member Accept", "3-1": "group_member.added" }, "cols": 2, "rows": 4 } [/block]
You may use webhooks to receive notifications, such as users being created and updated. Notifications are grouped into topics which can be subscribed to. You can create multiple webhooks that can listen for the notifications. When you add multiple webhooks you need to use api_application_key param for every request to show which key you are using for the webhooks. Mobilize allows users to create and update multiple items at once for example: upload an excel of users or upload users email list. As a result of that we created the [bulk notification object](https://dash.readme.io/project/mobilize/v1/docs/bulk-notifications-object). This object allows us to update you about all the items that has been created/changed through [notification objects](https://dash.readme.io/project/mobilize/v1/docs/notification-object), for more information please review: [bulk notification object](https://dash.readme.io/project/mobilize/v1/docs/bulk-notifications-object) and [notification object](https://dash.readme.io/project/mobilize/v1/docs/notification-object) topics. [block:callout] { "type": "info", "body": "The webhook API currently supports users and group members. Future considerations for improvements to the webhook API capabilities include groups and posts." } [/block] [block:api-header] { "type": "basic", "title": "Adding New Webhook" } [/block] In the "Community Settings" -> "integrations" you click on "Create new API key" and a new key will be generated. Make sure to store safely **API Application** key and **Secret key**. In case you lose them you need to generate a new API key and destroy the old one. [block:image] { "images": [ { "image": [ "https://files.readme.io/67284e3-Screenshot_2019-12-16_16.40.32.png", "Screenshot 2019-12-16 16.40.32.png", 1160, 390, "#ced8d8" ] } ] } [/block] A webhook subscription may be configured in the "Community Settings" -> "integrations" . Clicking "Webhooks Options" will show a form for editing the subscription. [block:image] { "images": [ { "image": [ "https://files.readme.io/QQMdXmZzTeSjXajP5e68_Screen%20Shot%202015-08-18%20at%202.07.09%20PM.png", "Screen Shot 2015-08-18 at 2.07.09 PM.png", "1010", "292", "#417d80", "" ] } ] } [/block] Make sure to select the notifications checkboxes to subscribe to specific events [block:image] { "images": [ { "image": [ "https://files.readme.io/8ee7d6b-Screen_Shot_2016-11-07_at_3.44.33_PM.png", "Screen Shot 2016-11-07 at 3.44.33 PM.png", 1160, 842, "#262732" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Securing Webhooks" } [/block] We support HTTP and HTTPS subscription URLs, and we recommend you provide a HTTPS URL to protect notifications. [block:api-header] { "type": "basic", "title": "Supported Topics" } [/block] The following topics may be subscribed to: [block:parameters] { "data": { "h-0": "Topic Description", "h-1": "Notification type", "0-0": "User Created", "0-1": "user.created", "1-0": "User Updated", "1-1": "user.updated", "2-0": "User Status Changed", "2-1": "user.status_changed", "3-0": "Group Member Accept", "3-1": "group_member.added" }, "cols": 2, "rows": 4 } [/block]
{"_id":"55d21d62945e481700afbb55","link_url":"","project":"55a50e92ec735f37000fc6df","slug":"bulk-notifications-object","sync_unique":"","title":"Bulk Notification Object","updates":[],"hidden":false,"body":"The Bulk API allows to send multiple notification objects in a single request for specific resources. This was built for cases where multiple objects are being updated at once\n\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Definition\",\n    \"0-0\": \"notifications\",\n    \"0-1\": \"Array[Hash]\",\n    \"0-2\": \"Represent an array of objects that has being created or updated.\",\n    \"1-0\": \"total\",\n    \"1-1\": \"Numeric\",\n    \"1-2\": \"A numeric number that describes the total items that has being issued.\",\n    \"2-0\": \"job\",\n    \"2-1\": \"Hash\",\n    \"2-2\": \"Holds the bulk job id\",\n    \"3-0\": \"next_page(Optional)\",\n    \"3-1\": \"Url\",\n    \"3-2\": \"We are sending only 50 items on each batch. it's your responsibility to query the rest of the items by calling the next_page url.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\t\\\"notifications\\\":[\\n      \\t{\\n          /*Notifications items*/\\n          \\\"item_type\\\":(String), //Name of the api object\\n          \\\"topic\\\":(String), //aka user_create, user.update\\n          \\\"item\\\":{\\n            //issued object\\n          }             \\n    \\t\\t}\\n    ],\\n  \\t\\\"total\\\":(Numeric),\\n    \\\"job\\\":{\\n         \\\"id\\\":(String)\\n    },\\n    \\\"next_page\\\":(Url)//Optional\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Limitations\"\n}\n[/block]\nMobilize allows users to create and update multiple items at once for example: upload an excel of users or upload users email list.\nAs a result of that we limited the amount of notifications to 50 notifications per request and we gave you the opportunity to query the rest of the notifications in bulks. for more information read more on bulk get API.","category":"55d07a212096360d00713799","githubsync":"","type":"basic","user":"55a50dd1750a9a23005332c6","version":"55a50e92ec735f37000fc6e2","__v":15,"api":{"url":"","auth":"required","params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":""},"excerpt":"","link_external":false,"order":1,"createdAt":"2015-08-17T17:44:02.113Z","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Bulk Notification Object


The Bulk API allows to send multiple notification objects in a single request for specific resources. This was built for cases where multiple objects are being updated at once [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Definition", "0-0": "notifications", "0-1": "Array[Hash]", "0-2": "Represent an array of objects that has being created or updated.", "1-0": "total", "1-1": "Numeric", "1-2": "A numeric number that describes the total items that has being issued.", "2-0": "job", "2-1": "Hash", "2-2": "Holds the bulk job id", "3-0": "next_page(Optional)", "3-1": "Url", "3-2": "We are sending only 50 items on each batch. it's your responsibility to query the rest of the items by calling the next_page url." }, "cols": 3, "rows": 4 } [/block] [block:code] { "codes": [ { "code": "{\n \t\"notifications\":[\n \t{\n /*Notifications items*/\n \"item_type\":(String), //Name of the api object\n \"topic\":(String), //aka user_create, user.update\n \"item\":{\n //issued object\n } \n \t\t}\n ],\n \t\"total\":(Numeric),\n \"job\":{\n \"id\":(String)\n },\n \"next_page\":(Url)//Optional\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Limitations" } [/block] Mobilize allows users to create and update multiple items at once for example: upload an excel of users or upload users email list. As a result of that we limited the amount of notifications to 50 notifications per request and we gave you the opportunity to query the rest of the notifications in bulks. for more information read more on bulk get API.
The Bulk API allows to send multiple notification objects in a single request for specific resources. This was built for cases where multiple objects are being updated at once [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Definition", "0-0": "notifications", "0-1": "Array[Hash]", "0-2": "Represent an array of objects that has being created or updated.", "1-0": "total", "1-1": "Numeric", "1-2": "A numeric number that describes the total items that has being issued.", "2-0": "job", "2-1": "Hash", "2-2": "Holds the bulk job id", "3-0": "next_page(Optional)", "3-1": "Url", "3-2": "We are sending only 50 items on each batch. it's your responsibility to query the rest of the items by calling the next_page url." }, "cols": 3, "rows": 4 } [/block] [block:code] { "codes": [ { "code": "{\n \t\"notifications\":[\n \t{\n /*Notifications items*/\n \"item_type\":(String), //Name of the api object\n \"topic\":(String), //aka user_create, user.update\n \"item\":{\n //issued object\n } \n \t\t}\n ],\n \t\"total\":(Numeric),\n \"job\":{\n \"id\":(String)\n },\n \"next_page\":(Url)//Optional\n}", "language": "json" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "Limitations" } [/block] Mobilize allows users to create and update multiple items at once for example: upload an excel of users or upload users email list. As a result of that we limited the amount of notifications to 50 notifications per request and we gave you the opportunity to query the rest of the notifications in bulks. for more information read more on bulk get API.
{"_id":"55d30139ac49f8210060d908","user":"55a50dd1750a9a23005332c6","api":{"url":"","auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":""},"body":"The object delivered to a webhook is a notification. Notifications have payloads, which contain the API’s existing JSON objects, such as user.\nThe notification object consist information about the API object type, method and actual object.\n\n**Bulk notification object**\nA notification object will always be an array of notifications inside a bulk object [read more about bulk object](https://dash.readme.io/project/mobilize/v1/docs/bulk-notifications-object).\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Definition\",\n    \"0-0\": \"item_type\",\n    \"0-1\": \"String\",\n    \"0-2\": \"Describe the API item type.\",\n    \"1-0\": \"topic\",\n    \"1-1\": \"String\",\n    \"1-2\": \"Describe the notification topic type. [read more at supported topics](https://mobilize.readme.io/docs/webhooks#supported-topics)\",\n    \"2-0\": \"item\",\n    \"2-1\": \"Hash\",\n    \"2-2\": \"The issued item.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\t\\\"item_type\\\":(String),\\n\\t\\\"topic\\\":(String),\\n\\t\\\"item\\\":{\\n  \\t...\\n\\t}             \\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","category":"55d07a212096360d00713799","hidden":false,"link_url":"","order":2,"project":"55a50e92ec735f37000fc6df","__v":4,"version":"55a50e92ec735f37000fc6e2","sync_unique":"","excerpt":"","githubsync":"","link_external":false,"slug":"notification-object","title":"Notification Object","type":"basic","updates":[],"createdAt":"2015-08-18T09:56:09.684Z","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

Notification Object


The object delivered to a webhook is a notification. Notifications have payloads, which contain the API’s existing JSON objects, such as user. The notification object consist information about the API object type, method and actual object. **Bulk notification object** A notification object will always be an array of notifications inside a bulk object [read more about bulk object](https://dash.readme.io/project/mobilize/v1/docs/bulk-notifications-object). [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Definition", "0-0": "item_type", "0-1": "String", "0-2": "Describe the API item type.", "1-0": "topic", "1-1": "String", "1-2": "Describe the notification topic type. [read more at supported topics](https://mobilize.readme.io/docs/webhooks#supported-topics)", "2-0": "item", "2-1": "Hash", "2-2": "The issued item." }, "cols": 3, "rows": 3 } [/block] [block:code] { "codes": [ { "code": "{\n\t\"item_type\":(String),\n\t\"topic\":(String),\n\t\"item\":{\n \t...\n\t} \n}", "language": "json" } ], "sidebar": true } [/block]
The object delivered to a webhook is a notification. Notifications have payloads, which contain the API’s existing JSON objects, such as user. The notification object consist information about the API object type, method and actual object. **Bulk notification object** A notification object will always be an array of notifications inside a bulk object [read more about bulk object](https://dash.readme.io/project/mobilize/v1/docs/bulk-notifications-object). [block:parameters] { "data": { "h-0": "Name", "h-1": "Type", "h-2": "Definition", "0-0": "item_type", "0-1": "String", "0-2": "Describe the API item type.", "1-0": "topic", "1-1": "String", "1-2": "Describe the notification topic type. [read more at supported topics](https://mobilize.readme.io/docs/webhooks#supported-topics)", "2-0": "item", "2-1": "Hash", "2-2": "The issued item." }, "cols": 3, "rows": 3 } [/block] [block:code] { "codes": [ { "code": "{\n\t\"item_type\":(String),\n\t\"topic\":(String),\n\t\"item\":{\n \t...\n\t} \n}", "language": "json" } ], "sidebar": true } [/block]
{"_id":"55d30dd1740ab435000aa5dc","__v":3,"category":"55d07a212096360d00713799","createdAt":"2015-08-18T10:49:53.207Z","githubsync":"","hidden":false,"link_url":"","next":{"description":"","pages":[]},"order":3,"project":"55a50e92ec735f37000fc6df","sync_unique":"","updates":[],"user":"55a50dd1750a9a23005332c6","api":{"settings":"","url":"/bulks/:id?offset=0&limit=50","auth":"required","examples":{"codes":[{"name":"","language":"curl","code":"REQUEST\ncurl 'https://api.mobilize.io/v1/bulks/:id?offset=0&limit=50'\n    -X GET\n    -u [API Key]:[API Secret]\n   \t-H 'Accept: application/json'    "}]},"method":"get","params":[{"_id":"55d30dd1740ab435000aa5df","ref":"","in":"path","required":true,"desc":"The job_id","default":"","type":"string","name":"id"},{"_id":"55d30dd1740ab435000aa5de","ref":"","in":"query","required":false,"desc":"","default":"50","type":"int","name":"limit"},{"_id":"55d30dd1740ab435000aa5dd","ref":"","in":"query","required":false,"desc":"","default":"0","type":"int","name":"offset"},{"_id":"5df7e0571d668e005531cc51","ref":"","in":"query","required":false,"desc":"API application key is obligatory if you have more than one API token created. You can find the key under integrations in the organization settings. Each API token has its own key","default":"","type":"string","name":"api_application_key"}],"results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  \t\"notifications\":[\n      \t{        \n          \"item_type\":'user',\n          \"topic\":'user.created',\n          \"item\":{\n            {\n     \t\t\t\t\t\"id\": \"1234\",\n     \t\t\t\t\t\"name\": \"Sam Cooper\",\n     \t\t\t\t\t\"first_name\": \"Sam\",\n     \t\t\t\t\t\"last_name\": \"Cooper\",\n     \t\t\t\t\t\"email\": \"[email protected]\",\n     \t\t\t\t\t\"updated_at\": 1433233515826,\n     \t\t\t\t\t\"created_at\": 1433233515826,\n     \t\t\t\t\t\"is_registered\": true,  \n     \t\t\t\t\t\"groups\": [\n        \t\t\t\t{\n           \t\t\t\t\"id\": 1234,\n           \t\t\t\t\"is_admin\": false,\n           \t\t\t\t\"last_invited_in\": 1433869292669,\n            \t\t\t\"status\":\"approved\"\n     \t\t\t\t\t\t}\n     \t\t\t\t\t],\n     \t\t\t\t\t\"avatar\": {\n       \t\t\t\t\t\"image\": \"URL to sam's original image\",\n\t\t   \t\t\t\t\t\"small_thumb\": \"URL to sam's original image 80x80 px\",\n\t\t   \t\t\t\t\t\"mini_thumb\": \"URL to sam's original image 30x30 px\",\n\t\t   \t\t\t\t\t\"thumb\": \"URL to sam's original image 280x280 px\"\n     \t\t\t\t\t},\n     \t\t\t\t\t\"fields\": {            \n\t\t\t\t \t\t\t\t\t\"email\":\"[email protected]\",\n         \t\t\t\t\t\"first_name\":\"Sam\",\n         \t\t\t\t\t\"last_name\":\"Cooper\"    \n     \t\t\t\t\t}     \n\t\t\t\t\t\t}\n          }      \t\t\n    \t\t},\n      ...\n    ],\n  \t\"total\":100,\n    \"job\":{\n         \"id\":\"zVVu3mtupXDzwMy1rxxNMw\"\n    },\n    \"next_page\":\"https://api.mobilize.io/v1/bulks/zVVu3mtupXDzwMy1rxxNMw?offset=50&limit=50\"\n}"},{"name":"Bad Request (when having multiple webhooks)","code":"{\n  \"error_message\": \"api_application_key param is obligatory with multiple API tokens\"\n}","language":"json","status":400}]}},"editedParams":true,"excerpt":"","slug":"get-a-single-bulk","link_external":false,"title":"Get a single bulk","type":"get","body":"","editedParams2":true,"isReference":false,"version":"55a50e92ec735f37000fc6e2","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getGet a single bulk


Path Params

id:
required
string
The job_id

Query Params

limit:
integer50
offset:
integer0
api_application_key:
string
API application key is obligatory if you have more than one API token created. You can find the key under integrations in the organization settings. Each API token has its own key

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"_id":"5df7ae7beb9ce10053dd24ed","project":"55a50e92ec735f37000fc6df","version":"55a50e92ec735f37000fc6e2","category":"5df7a91393b393006d697345","user":"5df7a57bde866704a92497b2","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-12-16T16:19:07.678Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"User Activity represents every activity the users in the organization have done. All the activities can be queried to get all the activities or filter by specific user or activity type.\n\nThere are many types of activity available described below. Each type of activity has different data for the object.\n[block:api-header]\n{\n  \"title\": \"Add Members\"\n}\n[/block]\nActivity when adding a list of users to multiple groups\n\nIn the request to show only these activities use activity_type=add_members\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"created_at\\\": \\\"2019-12-16T11:49:01Z\\\", \\n  \\\"group_id\\\": 19730, \\n  \\\"members_count\\\": 1, \\n  \\\"type\\\": \\\"added_members\\\", \\n  \\\"group_name\\\": \\\"User group\\\"\\n} \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Comment\"\n}\n[/block]\nActivity when a user writes a comment on the post\n\nIn the request to show only these activities use activity_type=comment\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" {\\n   \\\"type\\\": \\\"comment\\\", \\n   \\\"comment_type\\\": \\\"comment\\\", \\n   \\\"created_at\\\": \\\"2019-12-15T12:55:26Z\\\", \\n   \\\"content\\\": \\\"Great.\\\", \\n   \\\"post_id\\\": 151014, \\n   \\\"group_id\\\": 22173, \\n   \\\"receiver_id\\\": 22173, \\n   \\\"post_type\\\": \\\"quickpost\\\", \\n   \\\"feed_type\\\": \\\"lounge\\\", \\n   \\\"post_name\\\": \\\"New post.\\\"\\n } \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Comment Reply\"\n}\n[/block]\nActivity when a user replies to comment\n\nIn the request to show only these activities use activity_type=comment_reply\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"type\\\": \\\"comment\\\", \\n  \\\"comment_type\\\": \\\"reply\\\", \\n  \\\"created_at\\\": \\\"2019-12-15T12:40:47Z\\\", \\n  \\\"content\\\": \\\"<p>Interesting</p>\\\", \\n  \\\"post_id\\\": 151168, \\n  \\\"post_type\\\": \\\"quickpost\\\", \\n  \\\"feed_type\\\": \\\"lounge\\\", \\n  \\\"target\\\": {\\n    \\\"id\\\": 17774, \\n    \\\"type\\\": \\\"group\\\"\\n  }, \\n  \\\"post_name\\\": \\\"New post\\\"\\n} \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Conversation\"\n}\n[/block]\nActivity when a user sends a message to a private conversation\n\nIn the request to show only these activities use activity_type=conversation\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"created_at\\\": \\\"2019-12-15T12:51:28Z\\\", \\n  \\\"type\\\": \\\"conversation\\\", \\n  \\\"conversation_id\\\": \\\"5df554ba3e3f1e1a9900ae35\\\", \\n  \\\"initiator\\\" :  {\\n    \\\"id\\\": 1168642, \\n    \\\"name\\\": \\\"Rafał Palka\\\"\\n  }, \\n  \\\"participant\\\": {\\n    \\\"name\\\": \\\"Kamil Nosal\\\", \\n    \\\"id\\\": 1168728\\n  }, \\n  \\\"participants_count\\\": 2, \\n  \\\"participants\\\": [1168642, 1168728]\\n} \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Join Group\"\n}\n[/block]\nActivity when a user has joined the group\n\nIn the request to show only these activities use activity_type=join_group\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"created_at\\\": \\\"2019-12-16T11:49:01Z\\\", \\n  \\\"group_id\\\": 19730, \\n  \\\"group_name\\\": \\\"User group\\\", \\n  \\\"type\\\": \\\"joined_group\\\"\\n} \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Mention\"\n}\n[/block]\nActivity when a user has been mentioned in the post or comment messages\n\nIn the request to show only these activities use activity_type=mention\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"type\\\": \\\"mention\\\", \\n  \\\"mention_object\\\": \\\"Post\\\", \\n  \\\"created_at\\\": \\\"2019-12-15T11:19:18Z\\\", \\n  \\\"content\\\": \\\"<p>Read from here</p>\\\", \\n  \\\"mentioned\\\": \\\"John Miller\\\", \\n  \\\"post_id\\\": 151167, \\n  \\\"group_id\\\": 19314, \\n  \\\"receiver_id\\\": 19314, \\n  \\\"post_type\\\": \\\"quickpost\\\", \\n  \\\"feed_type\\\": \\\"lounge\\\", \\n  \\\"post_name\\\": \\\"Interesting Post\\\"\\n} \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Pending Applicant\"\n}\n[/block]\nActivity when a new user has been added to the group but it is still pending for confirmation\n\nIn the request to show only these activities use activity_type=pending_applicant\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"created_at\\\": \\\"2019-12-12T17:33:27Z\\\", \\n  \\\"group_id\\\": 20273, \\n  \\\"group_name\\\": \\\"Simple Group\\\", \\n  \\\"type\\\": \\\"pending_applicant\\\"\\n} \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Pending Post\"\n}\n[/block]\nActivity created when a new pending post has been created\n\nIn the request to show only these activities use activity_type=pending_post\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"created_at\\\": \\\"2019-07-29T09:24:45Z\\\",\\n    \\\"post_id\\\": 4,\\n    \\\"group_id\\\": 1,\\n    \\\"receiver_id\\\": 1,\\n    \\\"type\\\": \\\"pending_post\\\",\\n    \\\"post_type\\\": \\\"post\\\",\\n    \\\"feed_type\\\": \\\"lounge\\\",\\n    \\\"post_name\\\": \\\"New Post\\\",\\n    \\\"target\\\": {\\n        \\\"id\\\": 1,\\n        \\\"name\\\": \\\"New community\\\",\\n        \\\"type\\\": \\\"group\\\"\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Post\"\n}\n[/block]\nThis activity shows details about the new posts being created. \n\nIn the request to show only these activities use activity_type=post\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"created_at\\\": \\\"2019-07-29T09:24:45Z\\\",\\n    \\\"post_id\\\": 4,\\n    \\\"group_id\\\": 1,\\n    \\\"receiver_id\\\": 1,\\n    \\\"type\\\": \\\"post\\\",\\n    \\\"post_type\\\": \\\"post\\\",\\n    \\\"feed_type\\\": \\\"lounge\\\",\\n    \\\"post_name\\\": \\\"New Post\\\",\\n    \\\"target\\\": {\\n        \\\"id\\\": 1,\\n        \\\"name\\\": \\\"New community\\\",\\n        \\\"type\\\": \\\"group\\\"\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Post Approved\"\n}\n[/block]\nActivity created when a group administrator approves a pending post\n\nIn the request to show only these activities use activity_type=post_approved\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"created_at\\\"=>\\\"2019-07-21T09:42:48Z\\\", \\n  \\\"post_id\\\"=>145870, \\n  \\\"group_id\\\"=>4776, \\n  \\\"receiver_id\\\"=>4776, \\n  \\\"type\\\"=>\\\"post_approved\\\", \\n  \\\"post_type\\\"=>\\\"post\\\", \\n  \\\"feed_type\\\"=>\\\"lounge\\\", \\n  \\\"post_name\\\"=>\\\"Random Post\\\", \\n  \\\"target\\\"=>{\\n    \\\"id\\\"=>4776, \\n    \\\"name\\\"=>\\\"Community Group\\\", \\n    \\\"type\\\"=>\\\"group\\\"\\n  }\\n} \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Post Message\"\n}\n[/block]\nActivity when a user has responded to a private reply on a post.\n\nIn the request to show only these activities use activity_type=post_message\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"type\\\": \\\"comment\\\", \\n  \\\"comment_type\\\": \\\"message\\\", \\n  \\\"created_at\\\": \\\"2019-12-15T12:38:19Z\\\", \\n  \\\"content\\\": \\\"I agree.\\\", \\n  \\\"post_id\\\": 151168, \\n  \\\"receiver_id\\\": 17774, \\n  \\\"group_id\\\": 17774, \\n  \\\"post_type\\\": \\\"quickpost\\\", \\n  \\\"feed_type\\\": \\\"lounge\\\", \\n  \\\"target\\\": {\\n    \\\"id\\\": 17774, \\n    \\\"type\\\": \\\"group\\\"\\n  }, \\n  \\\"post_name\\\": \\\"New post\\\"\\n} \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Reaction\"\n}\n[/block]\nUser has reacted to post by liking the post\n\nIn the request to show only these activities use activity_type=reaction\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"type\\\": \\\"add_reaction\\\", \\n  \\\"created_at\\\": \\\"2019-12-15T12:39:37Z\\\", \\n  \\\"content\\\": \\\"👍\\\", \\n  \\\"post_id\\\": 151168, \\n  \\\"feed_type\\\": \\\"lounge\\\", \\n  \\\"group_id\\\": 17774, \\n  \\\"post_type\\\": \\\"quickpost\\\", \\n  \\\"receiver_id\\\": 17774, \\n  \\\"post_name\\\": \\\"New post\\\"\\n} \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"RSVP\"\n}\n[/block]\nWhen a user replies to RSVP to a specific event it creates an activity\n\nIn the request to show only these activities use activity_type=rsvp\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"created_at\\\": \\\"2019-12-14T18:00:35Z\\\", \\n  \\\"group_id\\\": 19414, \\n  \\\"event_id\\\": 21388, \\n  \\\"post_id\\\": 150428, \\n  \\\"post_type\\\": \\\"event\\\", \\n  \\\"feed_type\\\": \\\"lounge\\\", \\n  \\\"type\\\": \\\"rsvp\\\", \\n  \\\"status\\\": \\\"yes\\\", \\n  \\\"event_name\\\": \\\"New Year Meetup\\\", \\n  \\\"group_name\\\": \\\"Updates community\\\", \\n  \\\"target\\\": {\\n    \\\"id\\\": 19414, \\n    \\\"type\\\": \\\"group\\\"\\n  }\\n} \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"SMS Reply\"\n}\n[/block]\nActivity when a user replies to SMS post from outreach\n\nIn the request to show only these activities use activity_type=sms_reply\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" {\\n  \\\"type\\\": \\\"sms_reply\\\", \\n  \\\"comment_type\\\": \\\"reply\\\", \\n  \\\"created_at\\\": \\\"2017-12-24T05:13:55Z\\\", \\n  \\\"content\\\": \\\"I know\\\", \\n  \\\"post_id\\\": 134795, \\n  \\\"post_type\\\": \\\"smspost\\\", \\n  \\\"feed_type\\\": \\\"outreach\\\", \\n  \\\"target\\\": {\\n    \\\"id\\\": 17773, \\n    \\\"type\\\": \\\"group\\\"\\n  }, \\n  \\\"post_name\\\": null\\n} \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"View\"\n}\n[/block]\nWhen a user views specific content it logs the views\n\nIn the request to show only these activities use activity_type=view\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"created_at\\\": \\\"2019-12-15T15:41:20Z\\\", \\n  \\\"receiver_id\\\": 19332, \\n  \\\"group_id\\\": 19332, \\n  \\\"post_id\\\": 141574, \\n  \\\"post_type\\\": \\\"quickpost\\\", \\n  \\\"feed_type\\\": \\\"lounge\\\", \\n  \\\"type\\\": \\\"view\\\", \\n  \\\"post_name\\\": \\\"Sweet Recipes\\\", \\n  \\\"group_name\\\": \\\"Cookies group\\\", \\n  \\\"target\\\": {\\n    \\\"id\\\": 19332, \\n    \\\"type\\\": \\\"group\\\"\\n  }\\n} \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Vote\"\n}\n[/block]\nIt logs every user voting in the polls\n\nIn the request to show only these activities use activity_type=vote\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"created_at\\\": \\\"2019-12-15T11:45:55Z\\\", \\n  \\\"type\\\": \\\"vote\\\", \\n  \\\"post_id\\\": 149559, \\n  \\\"post_type\\\": \\\"poll\\\", \\n  \\\"feed_type\\\": \\\"lounge\\\", \\n  \\\"poll_name\\\": \\\"Do you support new marketing strategy\\\", \\n  \\\"group_id\\\": 21163, \\n  \\\"receiver_type\\\": \\\"group\\\", \\n  \\\"receiver_id\\\": 21163\\n} \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"activity-object","type":"basic","title":"User Activity Object","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

User Activity Object


User Activity represents every activity the users in the organization have done. All the activities can be queried to get all the activities or filter by specific user or activity type. There are many types of activity available described below. Each type of activity has different data for the object. [block:api-header] { "title": "Add Members" } [/block] Activity when adding a list of users to multiple groups In the request to show only these activities use activity_type=add_members [block:code] { "codes": [ { "code": "{\n \"created_at\": \"2019-12-16T11:49:01Z\", \n \"group_id\": 19730, \n \"members_count\": 1, \n \"type\": \"added_members\", \n \"group_name\": \"User group\"\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "Comment" } [/block] Activity when a user writes a comment on the post In the request to show only these activities use activity_type=comment [block:code] { "codes": [ { "code": " {\n \"type\": \"comment\", \n \"comment_type\": \"comment\", \n \"created_at\": \"2019-12-15T12:55:26Z\", \n \"content\": \"Great.\", \n \"post_id\": 151014, \n \"group_id\": 22173, \n \"receiver_id\": 22173, \n \"post_type\": \"quickpost\", \n \"feed_type\": \"lounge\", \n \"post_name\": \"New post.\"\n } ", "language": "json" } ] } [/block] [block:api-header] { "title": "Comment Reply" } [/block] Activity when a user replies to comment In the request to show only these activities use activity_type=comment_reply [block:code] { "codes": [ { "code": "{\n \"type\": \"comment\", \n \"comment_type\": \"reply\", \n \"created_at\": \"2019-12-15T12:40:47Z\", \n \"content\": \"<p>Interesting</p>\", \n \"post_id\": 151168, \n \"post_type\": \"quickpost\", \n \"feed_type\": \"lounge\", \n \"target\": {\n \"id\": 17774, \n \"type\": \"group\"\n }, \n \"post_name\": \"New post\"\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "Conversation" } [/block] Activity when a user sends a message to a private conversation In the request to show only these activities use activity_type=conversation [block:code] { "codes": [ { "code": "{\n \"created_at\": \"2019-12-15T12:51:28Z\", \n \"type\": \"conversation\", \n \"conversation_id\": \"5df554ba3e3f1e1a9900ae35\", \n \"initiator\" : {\n \"id\": 1168642, \n \"name\": \"Rafał Palka\"\n }, \n \"participant\": {\n \"name\": \"Kamil Nosal\", \n \"id\": 1168728\n }, \n \"participants_count\": 2, \n \"participants\": [1168642, 1168728]\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "Join Group" } [/block] Activity when a user has joined the group In the request to show only these activities use activity_type=join_group [block:code] { "codes": [ { "code": "{\n \"created_at\": \"2019-12-16T11:49:01Z\", \n \"group_id\": 19730, \n \"group_name\": \"User group\", \n \"type\": \"joined_group\"\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "Mention" } [/block] Activity when a user has been mentioned in the post or comment messages In the request to show only these activities use activity_type=mention [block:code] { "codes": [ { "code": "{\n \"type\": \"mention\", \n \"mention_object\": \"Post\", \n \"created_at\": \"2019-12-15T11:19:18Z\", \n \"content\": \"<p>Read from here</p>\", \n \"mentioned\": \"John Miller\", \n \"post_id\": 151167, \n \"group_id\": 19314, \n \"receiver_id\": 19314, \n \"post_type\": \"quickpost\", \n \"feed_type\": \"lounge\", \n \"post_name\": \"Interesting Post\"\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "Pending Applicant" } [/block] Activity when a new user has been added to the group but it is still pending for confirmation In the request to show only these activities use activity_type=pending_applicant [block:code] { "codes": [ { "code": "{\n \"created_at\": \"2019-12-12T17:33:27Z\", \n \"group_id\": 20273, \n \"group_name\": \"Simple Group\", \n \"type\": \"pending_applicant\"\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "Pending Post" } [/block] Activity created when a new pending post has been created In the request to show only these activities use activity_type=pending_post [block:code] { "codes": [ { "code": "{\n \"created_at\": \"2019-07-29T09:24:45Z\",\n \"post_id\": 4,\n \"group_id\": 1,\n \"receiver_id\": 1,\n \"type\": \"pending_post\",\n \"post_type\": \"post\",\n \"feed_type\": \"lounge\",\n \"post_name\": \"New Post\",\n \"target\": {\n \"id\": 1,\n \"name\": \"New community\",\n \"type\": \"group\"\n }\n}", "language": "json" } ] } [/block] [block:api-header] { "title": "Post" } [/block] This activity shows details about the new posts being created. In the request to show only these activities use activity_type=post [block:code] { "codes": [ { "code": "{\n \"created_at\": \"2019-07-29T09:24:45Z\",\n \"post_id\": 4,\n \"group_id\": 1,\n \"receiver_id\": 1,\n \"type\": \"post\",\n \"post_type\": \"post\",\n \"feed_type\": \"lounge\",\n \"post_name\": \"New Post\",\n \"target\": {\n \"id\": 1,\n \"name\": \"New community\",\n \"type\": \"group\"\n }\n}", "language": "json" } ] } [/block] [block:api-header] { "title": "Post Approved" } [/block] Activity created when a group administrator approves a pending post In the request to show only these activities use activity_type=post_approved [block:code] { "codes": [ { "code": "{\n \"created_at\"=>\"2019-07-21T09:42:48Z\", \n \"post_id\"=>145870, \n \"group_id\"=>4776, \n \"receiver_id\"=>4776, \n \"type\"=>\"post_approved\", \n \"post_type\"=>\"post\", \n \"feed_type\"=>\"lounge\", \n \"post_name\"=>\"Random Post\", \n \"target\"=>{\n \"id\"=>4776, \n \"name\"=>\"Community Group\", \n \"type\"=>\"group\"\n }\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "Post Message" } [/block] Activity when a user has responded to a private reply on a post. In the request to show only these activities use activity_type=post_message [block:code] { "codes": [ { "code": "{\n \"type\": \"comment\", \n \"comment_type\": \"message\", \n \"created_at\": \"2019-12-15T12:38:19Z\", \n \"content\": \"I agree.\", \n \"post_id\": 151168, \n \"receiver_id\": 17774, \n \"group_id\": 17774, \n \"post_type\": \"quickpost\", \n \"feed_type\": \"lounge\", \n \"target\": {\n \"id\": 17774, \n \"type\": \"group\"\n }, \n \"post_name\": \"New post\"\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "Reaction" } [/block] User has reacted to post by liking the post In the request to show only these activities use activity_type=reaction [block:code] { "codes": [ { "code": "{\n \"type\": \"add_reaction\", \n \"created_at\": \"2019-12-15T12:39:37Z\", \n \"content\": \"👍\", \n \"post_id\": 151168, \n \"feed_type\": \"lounge\", \n \"group_id\": 17774, \n \"post_type\": \"quickpost\", \n \"receiver_id\": 17774, \n \"post_name\": \"New post\"\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "RSVP" } [/block] When a user replies to RSVP to a specific event it creates an activity In the request to show only these activities use activity_type=rsvp [block:code] { "codes": [ { "code": "{\n \"created_at\": \"2019-12-14T18:00:35Z\", \n \"group_id\": 19414, \n \"event_id\": 21388, \n \"post_id\": 150428, \n \"post_type\": \"event\", \n \"feed_type\": \"lounge\", \n \"type\": \"rsvp\", \n \"status\": \"yes\", \n \"event_name\": \"New Year Meetup\", \n \"group_name\": \"Updates community\", \n \"target\": {\n \"id\": 19414, \n \"type\": \"group\"\n }\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "SMS Reply" } [/block] Activity when a user replies to SMS post from outreach In the request to show only these activities use activity_type=sms_reply [block:code] { "codes": [ { "code": " {\n \"type\": \"sms_reply\", \n \"comment_type\": \"reply\", \n \"created_at\": \"2017-12-24T05:13:55Z\", \n \"content\": \"I know\", \n \"post_id\": 134795, \n \"post_type\": \"smspost\", \n \"feed_type\": \"outreach\", \n \"target\": {\n \"id\": 17773, \n \"type\": \"group\"\n }, \n \"post_name\": null\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "View" } [/block] When a user views specific content it logs the views In the request to show only these activities use activity_type=view [block:code] { "codes": [ { "code": "{\n \"created_at\": \"2019-12-15T15:41:20Z\", \n \"receiver_id\": 19332, \n \"group_id\": 19332, \n \"post_id\": 141574, \n \"post_type\": \"quickpost\", \n \"feed_type\": \"lounge\", \n \"type\": \"view\", \n \"post_name\": \"Sweet Recipes\", \n \"group_name\": \"Cookies group\", \n \"target\": {\n \"id\": 19332, \n \"type\": \"group\"\n }\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "Vote" } [/block] It logs every user voting in the polls In the request to show only these activities use activity_type=vote [block:code] { "codes": [ { "code": "{\n \"created_at\": \"2019-12-15T11:45:55Z\", \n \"type\": \"vote\", \n \"post_id\": 149559, \n \"post_type\": \"poll\", \n \"feed_type\": \"lounge\", \n \"poll_name\": \"Do you support new marketing strategy\", \n \"group_id\": 21163, \n \"receiver_type\": \"group\", \n \"receiver_id\": 21163\n} ", "language": "json" } ] } [/block]
User Activity represents every activity the users in the organization have done. All the activities can be queried to get all the activities or filter by specific user or activity type. There are many types of activity available described below. Each type of activity has different data for the object. [block:api-header] { "title": "Add Members" } [/block] Activity when adding a list of users to multiple groups In the request to show only these activities use activity_type=add_members [block:code] { "codes": [ { "code": "{\n \"created_at\": \"2019-12-16T11:49:01Z\", \n \"group_id\": 19730, \n \"members_count\": 1, \n \"type\": \"added_members\", \n \"group_name\": \"User group\"\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "Comment" } [/block] Activity when a user writes a comment on the post In the request to show only these activities use activity_type=comment [block:code] { "codes": [ { "code": " {\n \"type\": \"comment\", \n \"comment_type\": \"comment\", \n \"created_at\": \"2019-12-15T12:55:26Z\", \n \"content\": \"Great.\", \n \"post_id\": 151014, \n \"group_id\": 22173, \n \"receiver_id\": 22173, \n \"post_type\": \"quickpost\", \n \"feed_type\": \"lounge\", \n \"post_name\": \"New post.\"\n } ", "language": "json" } ] } [/block] [block:api-header] { "title": "Comment Reply" } [/block] Activity when a user replies to comment In the request to show only these activities use activity_type=comment_reply [block:code] { "codes": [ { "code": "{\n \"type\": \"comment\", \n \"comment_type\": \"reply\", \n \"created_at\": \"2019-12-15T12:40:47Z\", \n \"content\": \"<p>Interesting</p>\", \n \"post_id\": 151168, \n \"post_type\": \"quickpost\", \n \"feed_type\": \"lounge\", \n \"target\": {\n \"id\": 17774, \n \"type\": \"group\"\n }, \n \"post_name\": \"New post\"\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "Conversation" } [/block] Activity when a user sends a message to a private conversation In the request to show only these activities use activity_type=conversation [block:code] { "codes": [ { "code": "{\n \"created_at\": \"2019-12-15T12:51:28Z\", \n \"type\": \"conversation\", \n \"conversation_id\": \"5df554ba3e3f1e1a9900ae35\", \n \"initiator\" : {\n \"id\": 1168642, \n \"name\": \"Rafał Palka\"\n }, \n \"participant\": {\n \"name\": \"Kamil Nosal\", \n \"id\": 1168728\n }, \n \"participants_count\": 2, \n \"participants\": [1168642, 1168728]\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "Join Group" } [/block] Activity when a user has joined the group In the request to show only these activities use activity_type=join_group [block:code] { "codes": [ { "code": "{\n \"created_at\": \"2019-12-16T11:49:01Z\", \n \"group_id\": 19730, \n \"group_name\": \"User group\", \n \"type\": \"joined_group\"\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "Mention" } [/block] Activity when a user has been mentioned in the post or comment messages In the request to show only these activities use activity_type=mention [block:code] { "codes": [ { "code": "{\n \"type\": \"mention\", \n \"mention_object\": \"Post\", \n \"created_at\": \"2019-12-15T11:19:18Z\", \n \"content\": \"<p>Read from here</p>\", \n \"mentioned\": \"John Miller\", \n \"post_id\": 151167, \n \"group_id\": 19314, \n \"receiver_id\": 19314, \n \"post_type\": \"quickpost\", \n \"feed_type\": \"lounge\", \n \"post_name\": \"Interesting Post\"\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "Pending Applicant" } [/block] Activity when a new user has been added to the group but it is still pending for confirmation In the request to show only these activities use activity_type=pending_applicant [block:code] { "codes": [ { "code": "{\n \"created_at\": \"2019-12-12T17:33:27Z\", \n \"group_id\": 20273, \n \"group_name\": \"Simple Group\", \n \"type\": \"pending_applicant\"\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "Pending Post" } [/block] Activity created when a new pending post has been created In the request to show only these activities use activity_type=pending_post [block:code] { "codes": [ { "code": "{\n \"created_at\": \"2019-07-29T09:24:45Z\",\n \"post_id\": 4,\n \"group_id\": 1,\n \"receiver_id\": 1,\n \"type\": \"pending_post\",\n \"post_type\": \"post\",\n \"feed_type\": \"lounge\",\n \"post_name\": \"New Post\",\n \"target\": {\n \"id\": 1,\n \"name\": \"New community\",\n \"type\": \"group\"\n }\n}", "language": "json" } ] } [/block] [block:api-header] { "title": "Post" } [/block] This activity shows details about the new posts being created. In the request to show only these activities use activity_type=post [block:code] { "codes": [ { "code": "{\n \"created_at\": \"2019-07-29T09:24:45Z\",\n \"post_id\": 4,\n \"group_id\": 1,\n \"receiver_id\": 1,\n \"type\": \"post\",\n \"post_type\": \"post\",\n \"feed_type\": \"lounge\",\n \"post_name\": \"New Post\",\n \"target\": {\n \"id\": 1,\n \"name\": \"New community\",\n \"type\": \"group\"\n }\n}", "language": "json" } ] } [/block] [block:api-header] { "title": "Post Approved" } [/block] Activity created when a group administrator approves a pending post In the request to show only these activities use activity_type=post_approved [block:code] { "codes": [ { "code": "{\n \"created_at\"=>\"2019-07-21T09:42:48Z\", \n \"post_id\"=>145870, \n \"group_id\"=>4776, \n \"receiver_id\"=>4776, \n \"type\"=>\"post_approved\", \n \"post_type\"=>\"post\", \n \"feed_type\"=>\"lounge\", \n \"post_name\"=>\"Random Post\", \n \"target\"=>{\n \"id\"=>4776, \n \"name\"=>\"Community Group\", \n \"type\"=>\"group\"\n }\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "Post Message" } [/block] Activity when a user has responded to a private reply on a post. In the request to show only these activities use activity_type=post_message [block:code] { "codes": [ { "code": "{\n \"type\": \"comment\", \n \"comment_type\": \"message\", \n \"created_at\": \"2019-12-15T12:38:19Z\", \n \"content\": \"I agree.\", \n \"post_id\": 151168, \n \"receiver_id\": 17774, \n \"group_id\": 17774, \n \"post_type\": \"quickpost\", \n \"feed_type\": \"lounge\", \n \"target\": {\n \"id\": 17774, \n \"type\": \"group\"\n }, \n \"post_name\": \"New post\"\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "Reaction" } [/block] User has reacted to post by liking the post In the request to show only these activities use activity_type=reaction [block:code] { "codes": [ { "code": "{\n \"type\": \"add_reaction\", \n \"created_at\": \"2019-12-15T12:39:37Z\", \n \"content\": \"👍\", \n \"post_id\": 151168, \n \"feed_type\": \"lounge\", \n \"group_id\": 17774, \n \"post_type\": \"quickpost\", \n \"receiver_id\": 17774, \n \"post_name\": \"New post\"\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "RSVP" } [/block] When a user replies to RSVP to a specific event it creates an activity In the request to show only these activities use activity_type=rsvp [block:code] { "codes": [ { "code": "{\n \"created_at\": \"2019-12-14T18:00:35Z\", \n \"group_id\": 19414, \n \"event_id\": 21388, \n \"post_id\": 150428, \n \"post_type\": \"event\", \n \"feed_type\": \"lounge\", \n \"type\": \"rsvp\", \n \"status\": \"yes\", \n \"event_name\": \"New Year Meetup\", \n \"group_name\": \"Updates community\", \n \"target\": {\n \"id\": 19414, \n \"type\": \"group\"\n }\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "SMS Reply" } [/block] Activity when a user replies to SMS post from outreach In the request to show only these activities use activity_type=sms_reply [block:code] { "codes": [ { "code": " {\n \"type\": \"sms_reply\", \n \"comment_type\": \"reply\", \n \"created_at\": \"2017-12-24T05:13:55Z\", \n \"content\": \"I know\", \n \"post_id\": 134795, \n \"post_type\": \"smspost\", \n \"feed_type\": \"outreach\", \n \"target\": {\n \"id\": 17773, \n \"type\": \"group\"\n }, \n \"post_name\": null\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "View" } [/block] When a user views specific content it logs the views In the request to show only these activities use activity_type=view [block:code] { "codes": [ { "code": "{\n \"created_at\": \"2019-12-15T15:41:20Z\", \n \"receiver_id\": 19332, \n \"group_id\": 19332, \n \"post_id\": 141574, \n \"post_type\": \"quickpost\", \n \"feed_type\": \"lounge\", \n \"type\": \"view\", \n \"post_name\": \"Sweet Recipes\", \n \"group_name\": \"Cookies group\", \n \"target\": {\n \"id\": 19332, \n \"type\": \"group\"\n }\n} ", "language": "json" } ] } [/block] [block:api-header] { "title": "Vote" } [/block] It logs every user voting in the polls In the request to show only these activities use activity_type=vote [block:code] { "codes": [ { "code": "{\n \"created_at\": \"2019-12-15T11:45:55Z\", \n \"type\": \"vote\", \n \"post_id\": 149559, \n \"post_type\": \"poll\", \n \"feed_type\": \"lounge\", \n \"poll_name\": \"Do you support new marketing strategy\", \n \"group_id\": 21163, \n \"receiver_type\": \"group\", \n \"receiver_id\": 21163\n} ", "language": "json" } ] } [/block]
{"_id":"5df7aac6c275f50025c77a1b","project":"55a50e92ec735f37000fc6df","version":"55a50e92ec735f37000fc6e2","category":"5df7a91393b393006d697345","user":"5df7a57bde866704a92497b2","updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-12-16T16:03:18.324Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n  activites: [{\n    \"id\": 231,\n    \"created_at\": \"2019-07-29T09:24:45Z\",\n    \"post_id\": 4,\n    \"group_id\": 1,\n    \"receiver_id\": 1,\n    \"type\": \"post\",\n    \"post_type\": \"post\",\n    \"feed_type\": \"lounge\",\n    \"post_name\": \"New Post\",\n    \"target\": {\n        \"id\": 1,\n        \"name\": \"New community\",\n        \"type\": \"group\"\n    }\n  }],\n  total_activities: 200,\n  next_page: \"https://api.mobilize.io/v1/activities?last_activity_id=231&limit=1\"# A url you can call for getting the next page of activities\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[{"_id":"5df7acfc6141df0011fbbead","ref":"","in":"query","required":false,"desc":"Use only if you want to receive activities from only specific member, otherwise it returns activities for all members in the organization","default":"","type":"int","name":"member_id"},{"_id":"5df7acfc6141df0011fbbeac","ref":"","in":"query","required":false,"desc":"It can be filtered down by activity types that are the following, post_approved, post, pending_post, view, comment, comment_reply, post_message, sms_reply, rsvp, vote, reach, file_download, pending_applicant, add_members, remove_members, join_group, destroy_group, conversation, remove_single_member, reaction, remove, mention","default":"","type":"string","name":"activity_type"},{"_id":"5df7acfc6141df0011fbbeaa","ref":"","in":"query","required":false,"desc":"The maximum number of activities the query will return. The maximum we allow is 50.","default":"20","type":"int","name":"limit"},{"_id":"5e20ae3a2726ce05171a911f","ref":"","in":"query","required":false,"desc":"The last activity from which you want to query","default":"","type":"string","name":"last_activity_id"}],"url":"/activities","examples":{"codes":[{"language":"curl","code":"curl 'https://api.mobilize.io/v1/activities/?limit=1'\n\t\t\t-X GET\n      -u [API Key]:[API Secret]\n      -H 'Accept: application/json'"}]},"method":"get"},"isReference":false,"order":1,"body":"The activities will always be ordered by the created_at on descending order. So you will always get the latest activities first.\n\nYou can use the next_page url in the response to fetch the next page of activities.","excerpt":"","slug":"user-activities","type":"get","title":"User Activities","__v":10,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}

getUser Activities


Query Params

member_id:
integer
Use only if you want to receive activities from only specific member, otherwise it returns activities for all members in the organization
activity_type:
string
It can be filtered down by activity types that are the following, post_approved, post, pending_post, view, comment, comment_reply, post_message, sms_reply, rsvp, vote, reach, file_download, pending_applicant, add_members, remove_members, join_group, destroy_group, conversation, remove_single_member, reaction, remove, mention
limit:
integer20
The maximum number of activities the query will return. The maximum we allow is 50.
last_activity_id:
string
The last activity from which you want to query
The activities will always be ordered by the created_at on descending order. So you will always get the latest activities first. You can use the next_page url in the response to fetch the next page of activities.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



The activities will always be ordered by the created_at on descending order. So you will always get the latest activities first. You can use the next_page url in the response to fetch the next page of activities.